Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kdlamini/math-magicians
Math magicians is a website for all fans of mathematics. It is a Single Page App (SPA) that allows users to make simple calculations and read a random math-related quote. Built with React.
https://github.com/kdlamini/math-magicians
Last synced: 23 days ago
JSON representation
Math magicians is a website for all fans of mathematics. It is a Single Page App (SPA) that allows users to make simple calculations and read a random math-related quote. Built with React.
- Host: GitHub
- URL: https://github.com/kdlamini/math-magicians
- Owner: KDlamini
- Created: 2021-10-18T13:10:35.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-06-26T17:45:46.000Z (over 2 years ago)
- Last Synced: 2023-03-11T02:53:22.018Z (almost 2 years ago)
- Language: JavaScript
- Homepage: https://kdlamini.github.io/math-magicians/
- Size: 2.55 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Math Magicians
Math magicians is a website for all fans of mathematics. It is a Single Page App (SPA) that allows users to make simple calculations and read a random math-related quote.
This project is part of the Microverse curriculum module 3. The main objective is to understand how create a React app, use class based-components, hooks, state, run tests, and creating professional documentation for development.
## Live Preview
Netlify: [https://math-magicians-3551.netlify.app/](https://math-magicians-3551.netlify.app/)
## Built With
- React
- JavaScript
- CSS
## Additional Tools
- Stylelint
- Eslint
- babel
- Jest
## `Getting Started`
To get a local copy of this project:
Clone this repository or download the Zip folder:
```
[email protected]:KDlamini/math-magicians.git
```
To get started, In the project directory, you can run:
```
yarn install OR npm install
```
run react app and open in browser:
```
yarn start OR npm start
```
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
If you encounter an issue related to eslint or webpack version conflict run:
```
yarn audit fix --force OR npm audit fix --force
```
## `Tests`
To check development tests run:
```
yarn test OR npm run test
```
Launches the test runner in the interactive watch mode.
### To track linter errors locally follow these steps:
Track CSS linter errors run:
```
npx stylelint "**/*.{css,scss}"
```
Track JavaScript linter errors run:
```
npx eslint .
```
## `Deployement`
```
yarn build OR npm 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!
### `yarn 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.
## Authors
👤 **Simo Nkosi**
- GitHub: [@KDlamini](https://github.com/KDlamini)
- Twitter: [@RealSimoNkosi](https://twitter.com/RealSimoNkosi)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/simo-nkosi-418523180/)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/KDlamini/math-magicians/issues).
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
- This project is part of week 1 of module 3 in the Microverse study program.
- Thanks to the Microverse team for the great curriculum.
- Thanks to Code Reviewers for the insightful feedback.
- A great thanks to My coding partners, morning session team, and standup team Partners for their contributions.
## 📝 License
This project is [MIT](./MIT.md) licensed.