https://github.com/faranoshamini/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/faranoshamini/math-magicians
css html javascript react webpack
Last synced: 3 months 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/faranoshamini/math-magicians
- Owner: FaranoshAmini
- License: mit
- Created: 2022-10-24T18:22:19.000Z (over 3 years ago)
- Default Branch: development
- Last Pushed: 2024-02-01T14:51:28.000Z (over 2 years ago)
- Last Synced: 2025-03-29T14:13:55.294Z (over 1 year ago)
- Topics: css, html, javascript, react, webpack
- Language: JavaScript
- Homepage:
- Size: 416 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
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.
## Built With
- React
- CSS
- Linters (Lighthouse, Webhint, Stylelint, Eslint)
- Gitflow
- Jest
## Live Demo
For the live demo click [here](https://faranosh-math-magicians.netlify.app/)
## Author
👤 **Faranosh Amini**
- GitHub: [@FaranoshAmini](https://github.com/FaranoshAmini)
- LinkedIn: [@Faranosh_Amini](https://www.linkedin.com/in/faranosh-amini-9b925b23a/)
- Twitter: [@Faranosh_Amini](https://twitter.com/Faranosh_Amini)
## Getting Started
To get a local copy up and running follow these simple example steps.
- Clone this repository with git clone`https://github.com/FaranoshAmini/Math-Magicians` using your terminal or command line.
- Change to the project directory by entering :
`cd Math-Magicians` in the terminal.
### Prerequisites
You need to make sure to have installed the latest version of Node.js and npm on your computer.
### Setup
You can clone this repository or simply download the files as a .zip
If you want to set up a personal repository based on this one, you can as well fork it.
### Install
After clone it and before working on it, you have to run `npm install` so that all the dependencies of the project get downloaded in your pc locally.
Such dependencies include webpack and linters checks, for which you have to either generate your own config file or get one.
- `npm run build`
- `npm run start`
### Run tests for linter and unit tests
- `npx hint .`
- `npx stylelint "**/*.scss"`
- `npx eslint .`
- `npm run test`
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
- Microverse
## 📝 License
This project is [MIT](./MIT.md) licensed.