Table of Contents
This is a simple react application where a user can prank their friends by sending them a link to the application with their name and prank type embedded in the url.
Below are the steps to install the application on your local machine.
Install npm and react.js to run the application.
- npm
npm install npm@latest -g
Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.
- Set up node.js and react.js as described above.
- install Material UI using
npm install @mui/material @emotion/react @emotion/styled
- Clone the repo
git clone https://github.com/your_username_/Project-Name.git
- Install NPM packages
npm install
Start the react application using:
npm startNow open the browser to the correct url and port created by the server.
- Finish basic implementations
- Add testcases
- Add more pranks
- Optimise and modularise the code.
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt for more information.
Your Name - Anandu_Raveendran
Project Codebase: [https://github.com/Anandu-Raveendran/react-pranker)
Project Demo : [https://anandu-raveendran.github.io/react-pranker)
