https://github.com/tsohledev/math-magicians
Math magicians is a front end only web app created with React to compute simple arithmetic expressions using a interactive calculator in DOM
https://github.com/tsohledev/math-magicians
react
Last synced: about 2 months ago
JSON representation
Math magicians is a front end only web app created with React to compute simple arithmetic expressions using a interactive calculator in DOM
- Host: GitHub
- URL: https://github.com/tsohledev/math-magicians
- Owner: tsohleDev
- License: mit
- Created: 2023-01-10T02:14:10.000Z (over 3 years ago)
- Default Branch: develop
- Last Pushed: 2023-01-20T13:34:47.000Z (over 3 years ago)
- Last Synced: 2025-01-21T04:32:20.264Z (over 1 year ago)
- Topics: react
- Language: JavaScript
- Homepage:
- Size: 352 KB
- Stars: 1
- 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
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
> About this repository
**Math MAgicians** is a front end only web app created with React to compute simple arithmetic expressions using a interactive calculator in DOM
> My stack is consists only of the client side framework
Client
> Describe between 1-3 key features of the application.
- **[SPA]**
- **[Make arithmetic calculations]**
- **[Read math qoutes]**
> Add a link to your deployed project.
- [Live Demo Link](https://tsohle.me/Math-Magicians)
> How to clone and use this project project.
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
-A working browser application (Google chrome, Mozilla Fire fox, Microsoft edge ...)
-VSCode or any other equivalent code editor
-Node Package Manager (For running, debuging, or installing dependancies to be used)
node and npm:
-Linux
```sh
sudo apt install nodejs npm
```
-windows
[download and install](https://nodejs.org/en/)
### Setup
Clone this repository to your desired folder:
- Open the command prompt in the created directory.
- On the terminal run this command
```sh
git clone https://github.com/tsohleDev/Math-Magicians.git
```
- Go to the repository folder using command prompt
```sh
cd Math-Magicians
```
### Install
Install this project with:
```sh
run npm install
```
### Usage
To run the project, execute the following command:
```sh
npm start
```
### Run tests
To run tests, run the following command:
```sh
npm run watch
```
-
### Deployment
You can deploy this project using:
- To start run
```sh
npm run publish
```
> All of the collaborators of this project.
👤 **Tsohle Mokhemisi**
- GitHub: [@githubhandle](https://github.com/tsohleDev2)
- Twitter: [@twitterhandle](https://twitter.com/RealTsohle)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/tsohle-mokhemisi-3687401b2/)
> Describe 1 - 3 features you will add to the project.
- [ ] **[Make the calculator scientific]**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
> To support this project
Give a ⭐️ if you like this project!
> Credits to everyone who inspired the codebase.
I would like to thank [Microverse](https://microverse.org) for the great content
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._