- π About the Project
- π» Getting Started
- π₯ Authors
- π Future Features
- π€ Contributing
- βοΈ Show your support
- π Acknowledgements
- β FAQ (OPTIONAL)
- π License
Math Magicians is React-based App for math fans. It showcases React, API interactivity, Jest testing and Redux.
- Setup React App
- ** Implemente static React Calculator**
To get a local copy up and running, follow these steps. To run local server or to make any modifications to the project NPM and Node.js must be installed.
In order to run this project you need: To clone or fork and run it in a browser
Clone this repository to your desired folder:
For example, using Ubuntu:
cd my-desired-folder
git clone git@github.com:lordksix/math-magic.git
For more information on how to clone or fork a repository:
If you want to make any kind of change or modification, Node.Js and NPM is necesary. For more information on how to install node.js and npm:
To install dependencies, the following command must be run in the terminal:
cd math-magic
npm install
In the project directory, you can run:
npm start
Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.
The page will reload when you make changes.
You may also see any lint errors in the console.
npm run build
Builds the app for production to the build
folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
npm run eject
Note: this is a one-way operation. Once you eject
, you can't go back!
If you aren't satisfied with the build tool and configuration choices, you can eject
at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject
will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
You don't have to ever use eject
. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
npm run deploy
Deploys the App to the gh-pages from of the current repository.
Launches the test runner in the interactive watch mode.
npm test
π€ Author
- GitHub: @tjay1760
- Github: @Nahid1911
Future changes:
- Add states and evetns to calculator
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
If you like this project, I encourage you to clone, fork and contribute. Our community and knowledge grows with each engagement.
I would like to thank Microverse for the template for this project.
-
Do I need a IDE or a special text editor to make changes?
- No, you don't. You can use NotePad to make changes.
This project is MIT licensed.