https://github.com/balikuddembe/math-magicians-app
"Math Magicians" is a website that caters to mathematics enthusiasts and is designed as a Single Page Application (SPA). This website provides users with the ability to perform basic calculations and access a random math-related quote.
https://github.com/balikuddembe/math-magicians-app
html-css-javascript jest react
Last synced: 3 months ago
JSON representation
"Math Magicians" is a website that caters to mathematics enthusiasts and is designed as a Single Page Application (SPA). This website provides users with the ability to perform basic calculations and access a random math-related quote.
- Host: GitHub
- URL: https://github.com/balikuddembe/math-magicians-app
- Owner: Balikuddembe
- License: mit
- Created: 2023-02-13T19:44:40.000Z (over 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-02-25T11:00:00.000Z (about 2 years ago)
- Last Synced: 2025-01-15T20:20:49.390Z (4 months ago)
- Topics: html-css-javascript, jest, react
- Language: JavaScript
- Homepage: https://frontendmathsmagician.onrender.com/
- Size: 1.3 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Math Magician App
# 📗 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-)
- [🚀 Live Demo ](#-live-demo-)
- [💻 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 ](#-faq-)
- [📝 License ](#-license-)
**Math Magicians** is a website for all fans of mathematics. It is a Single Page App (SPA) that allows users to:
* Make simple calculations.
* Read a random math-related quote.
Client
- **Make calculations more scientific**
- **Read a random math-related quote**
- [Click Here for a Live Demo](https://frontendmathsmagician.onrender.com)
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
```npm start```
### Setup
Clone this repository to your desired folder:
```git clone https://github.com/Balikuddembe/Math-Magicians-APP.git```
### Usage
To run the project, execute the following command:
`npm start`
### Run tests
To run tests, run the following command:
```npm run test```
### Deployment
👤 Emmanuel Balikuddembe
- GitHub: [@Balikuddembe](https://github.com/Balikuddembe)
- Twitter: [@BalixEmma](https://twitter.com/BalixEmma/)
- LinkedIn: [emmanuel-balikuddembe](https://www.linkedin.com/in/emmanuelbalikuddembe/)
👤 Gueleu S. Farida
- GitHub: [@SFarida](https://github.com/SFarida)
- Twitter: [@First_Dialo](https://twitter.com/First_Dialo)
- LinkedIn: [farida-gueleu](https://linkedin.com/in/farida-gueleu/)
- [ ] **Add more scientific operations to the calculator**
- [ ] **Different Math quotes should display on a daily**
- [ ] **Add a mobile version**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/Balikuddembe/Math-Magicians-APP/issues)).
If you like this project please give it a star 😁🌟✨
> Give credit to everyone who inspired your codebase.
I would like to thank my partner Gueleu S. Farida for her technical expertise and collaborative spirit were instrumental in shaping the direction of this project, and I learned a lot from working with her. Additionally, I would like to acknowledge the contributions of the open source community, whose libraries and frameworks made it possible to build this project efficiently and effectively. Thank you all for your invaluable contributions.
- **What are the required software and tooling I need to have installed in order to work with this React app?**
- You need to have Node.js and a package manager like npm or yarn installed on your local machine
- **How can I run the React app locally and make changes to it? Are there any specific commands I need to run, or any particular files I need to modify in order to see my changes reflected in the app?**
- Open a command prompt or terminal window and navigate to the root directory of your React app.
- Run the command npm start or yarn start (depending on your package manager) to start the development server.
- Once the development server is running, you should be able to view the app in your web browser by navigating to http://localhost:3000 (unless you have specified a different port in your app configuration).
- To make changes to the app, you can edit the source code files in the src directory. The development server should automatically reload the app in your browser whenever you save changes to your code.
- If you encounter any issues while making changes to the app, you may want to check the console output in your browser's developer tools for any error messages or warnings. You can also consult the React documentation or community forums for troubleshooting help.
This project is [MIT](./LICENSE) licensed.
_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._