Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kendoriddy/math-magicians
"Math-Magician" is a web app for all lovers of mathematics. It is a Single Page Application (SPA) that allows users to make simple calculations, generate and read random math-related quotes and also tweet the quote.
https://github.com/kendoriddy/math-magicians
css javascript react react-router
Last synced: 26 days ago
JSON representation
"Math-Magician" is a web app for all lovers of mathematics. It is a Single Page Application (SPA) that allows users to make simple calculations, generate and read random math-related quotes and also tweet the quote.
- Host: GitHub
- URL: https://github.com/kendoriddy/math-magicians
- Owner: kendoriddy
- Created: 2022-09-05T15:36:18.000Z (over 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-04-07T08:45:14.000Z (over 1 year ago)
- Last Synced: 2024-10-19T03:34:55.727Z (2 months ago)
- Topics: css, javascript, react, react-router
- Language: JavaScript
- Homepage: https://mathe-magic.netlify.app/
- Size: 62.5 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Math-Magicians
"Math-Magician" is a web app for all lovers of mathematics. It is a Single Page Application (SPA) that allows users to make simple calculations and read a random math-related quote.
The goal here is to Build a single page web application for mathematics weebs using the React library
## Built With
- React
- Linters
## Live Demo
[Live demo](https://mathe-magic.netlify.app/)
### Prerequisites
The basic requirements for building the executable are:
- A working browser application (Google chrome, Mozilla Fire fox, Microsoft edge ...)
- Have a good knowledge on how to parse UI designs
- Have VSCode or other text editor installed. [Link to download VSCode](https://code.visualstudio.com/download)
- Install node package. [Link to download node](https://nodejs.org/en/download/)
- Have git installed.[Link to download git](https://git-scm.com/downloads)
- Create a github repository.
## Getting Started
To get a local copy up and running follow these simple example steps.
### Cloning the project
```
git clone https://github.com/kendoriddy/math-magicians.git
```
```
cd
```
## Getting packages and dependencies
To get all package modules required to build the project run:
```
npm install
```
every package module required to build the project is listed in the package.json file. this is used as a reference to get all dependencies.
## Building
To build the project run:
```
npm run build
```
after you run this successfully you'd locate the build from in the ```build``` folder located from the parent directory of the project.
## Running
To run the program on a browser through a server run this command in your cli
```
npm start
```
This should open the page in your localhost on port 3000. then you'd be able to view the built page generated using webpack.
## Run tests
For tracking linters errors locally, you need to follow these steps:
- For tracking linter errors in CSS file run:
```
npx stylelint "**/*.{css,scss}"
```
- For tracking linter errors in Javascript file run:
```
npx eslint .
```
## 🤝 Contributing
Feel free to check the [issues page](../../issues/).
👤 **Kehinde Ridwan Onifade**
- GitHub: [@githubhandle](https://github.com/kendoriddy)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/kehindeonifade)
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
- Microverse
## 📝 License
This project is [MIT](./MIT.md) licensed.