https://github.com/grandi0z/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/grandi0z/math_magicians
babel javascript jsx 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/grandi0z/math_magicians
- Owner: Grandi0z
- License: mit
- Created: 2023-07-10T19:32:26.000Z (almost 3 years ago)
- Default Branch: dev
- Last Pushed: 2023-07-28T17:30:42.000Z (almost 3 years ago)
- Last Synced: 2025-03-29T12:12:14.307Z (about 1 year ago)
- Topics: babel, javascript, jsx, react, webpack
- Language: JavaScript
- Homepage:
- Size: 3.49 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Math Magicians
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 Math Magicians ](#-math-magicians-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [❓ FAQ (OPTIONAL) ](#-faq-optional-)
- [📝 License ](#-license-)
**Math Magicians** Calculator
The following stacks were used
Not yet published
- **Make simple math operations**
- **Display quotes**
## 🚀 Live Demo Live Demo
### Prerequisites
In order to run this project you need to have a browser and of course a code editor
### Setup
Clone this repository to your desired folder, you can also set up HTML, CSS and JavaScript linters, for this you will need node installed. you can follow the steps [here](https://github.com/microverseinc/linters-config/tree/master/html-css) and [here](https://github.com/microverseinc/linters-config/tree/master/javascript) to setup the linters
### Install
Once you cloned this project you are done !
### Usage
To run the project follow these steps :
1. Install `Node.js` and `npm` on your computer (If you don't have them yet).
2. Open your terminal and navigate to the root directory of your project.
3. Run the command ```$npm start ``` in your terminal.
4. Your default browser should open automatically and display your React app
### Run tests
If you follow the tutorial above to setup linters then you can run these tests
```$
npx hint .
```
```$
npx stylelint "**/*.scss"
```
or if you use css then run this instead of the latter command above
```$
npx stylelint "**/*.{css,scss}"
```
### Deployment
You can deploy this project using: GitHub Pages
👤 **Joseph L Kausi**
- GitHub: [@Grandi0z](https://github.com/Grandi0z)
- Twitter: [@Joseph_LSK](https://twitter.com/Joseph_LSK)
- LinkedIn: [Joseph L Kausi](https://www.linkedin.com/in/joseph-lwanzo-khausi-bb8782139/)
- [ ] **Add a beautiful UI**
- [ ] **Put calculator and quotes on different pages**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/Grandi0z/Leaderboard/issues).
If you like this project you can follow me on github for more.
thanks to Microverse for providing the necessary resources.
- **Are the linters necessary?**
- It is a good practice to install and use them as they guide you towards best practice, but yes you can do without.
This project is [MIT](https://github.com/Grandi0z/Math_magicians/blob/design/LICENSE) licensed.