Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aachourmohamed/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.
https://github.com/aachourmohamed/math-magicians
react reactjs
Last synced: 4 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.
- Host: GitHub
- URL: https://github.com/aachourmohamed/math-magicians
- Owner: AACHOURMOHAMED
- Created: 2022-08-01T14:14:43.000Z (over 2 years ago)
- Default Branch: dev
- Last Pushed: 2022-08-21T20:57:41.000Z (over 2 years ago)
- Last Synced: 2024-12-09T21:09:21.797Z (14 days ago)
- Topics: react, reactjs
- Language: JavaScript
- Homepage:
- Size: 1.52 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
> Coming soon
## 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:
```
https://github.com/AACHOURMOHAMED/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!
👤 **AshourMohamed**
- GitHub: [@githubhandle](https://github.com/AACHOURMOHAMED)
- Twitter: [@twitterhandle](https://twitter.com/MohamedAachour3)
- LinkedIn: [LinkedIn](https://linkedin.com/in/mohamed-aachour-25405b215)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/AACHOURMOHAMED/LEADERBOARD/issues).
## Show your support
Give a ⭐️ if you like this project!
## 📝 License
This project is [MIT](./MIT.md) licensed.