Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/billymohajeri/math-magicians-setup-3

"Math magicians" is a website for all fans of mathematics. It is a Single Page App (SPA) that allows users to: 1- Make simple calculations. 2- Read a random math-related quote.
https://github.com/billymohajeri/math-magicians-setup-3

css react

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

# 📖 Math Magician

**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.

app-screenshot-1
app-screenshot-2
app-screenshot-3

## 🛠 Built With

### Tech Stack

Client

### Key Features

- Make simple calculations
- Read a random math-related quote

(back to top)

## 🚀 Live Demo

[Live Demo Link](https://billy-math-magicians.onrender.com/)

(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:

- Code Editor: VS Code
- Web Browser
- Node
- Git

### Setup

- Clone the repository
- Change directory into the project folder

Example commands:

```sh
git clone [email protected]:billymohajeri/Math-Magicians-Setup-3.git
```

### Install

Install this project with:

Example command:

`npm install`

### Usage

To run the project, execute the following command:

`npm start`

### Run tests

To run tests, run the following command:

Example command:

`npm test`

(back to top)

## 👥 Authors

👤 **Billy Mohajeri**

- GitHub: [@BillyMohajeri](https://github.com/billymohajeri)
- Twitter: [@BillyMohajeri](https://twitter.com/BillyMohajeri)
- LinkedIn: [@BillyMohajeri](https://www.linkedin.com/in/billymohajeri)

(back to top)

## 🔭 Future Features

- Add some tests

(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

If you like this project, you can support me by giving a ⭐.

(back to top)

## 🙏 Acknowledgments

I would like to thank all of my code reviewers for giving me constructive feedback.

(back to top)

## 📝 License

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

(back to top)