Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/abdelaziz-mahdi/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. - Read a random Math-related quote.
https://github.com/abdelaziz-mahdi/math-magicians

api calculator-application math react spa

Last synced: 28 days 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. - Read a random Math-related quote.

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](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 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

### Tech Stack

Languages & bundlers


  • JSX

  • CRA

  • Jest

Server


  • Render

Database


  • API Ninjas

### Key Features

- **Use GitFlow.**
- **Single page React app.**
- **Consume app data from API.**

(back to top)

## 🚀 Live Demo

- [Math-Magicians Live Demo](https://math-magicians-5wnx.onrender.com/) //
*Press `Ctrl + click` to open the link in a new tab.*

(back to top)

## 💻 Getting Started

To get a local copy up and running, follow these steps.

### Prerequisites

In order to run this project you need:

- Install Node.js.
- Visual Studio Code or equivalent.
- Internet Browser

### Setup

Clone this repository to your desired folder:

- cd my-folder
- git clone [https://github.com/Abdelaziz-Ali/Math-Magician.git](https://github.com/Abdelaziz-Ali/Math-Magician.git)

### Install

Install this project with:

- cd my-project
- git config --global --add safe.directory my-directory/my-folder/my-project

### Usage

To run the project, execute the following command:

- code .
- npm install
- npm start

### Run tests

To run tests, run the following command:

npm test

### Deployment

You can deploy this project using:

- Render.

(back to top)

## 👥 Authors

👤 Abdelaziz Ali

- GitHub: [@Abdelaziz-Ali](https://github.com/Abdelaziz-Ali)
- Twitter: [@AbdelazizDV](https://twitter.com/AbdelazizDV)
- LinkedIn: [in/abdelaziz-mahdi](https://www.linkedin.com/in/abdelaziz-mahdi)

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

## 🙏 Acknowledgments

- Templete used in project provided by (Microverse)!
- Icon and logo by Tristan Edwards @iconfinder.com.

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.

(back to top)