https://github.com/indiecodermm/math-magicians

A website for all math enthusiasts which provides an easy-to-use calculator and famous math quotes. Built with React.
https://github.com/indiecodermm/math-magicians

create-react-app javascript react-router reactjs single-page-app

Last synced: 6 months ago
JSON representation

A website for all math enthusiasts which provides an easy-to-use calculator and famous math quotes. Built with React.

• Host: GitHub
• URL: https://github.com/indiecodermm/math-magicians
• Owner: IndieCoderMM
• License: mit
• Created: 2023-01-09T09:56:50.000Z (about 3 years ago)
• Default Branch: develop
• Last Pushed: 2023-01-19T05:49:28.000Z (about 3 years ago)
• Last Synced: 2025-01-16T00:08:04.250Z (about 1 year ago)
• Topics: create-react-app, javascript, react-router, reactjs, single-page-app
• Language: JavaScript
• Homepage: https://math-magicians-oart.onrender.com
• Size: 1.5 MB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


## 📑 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)

  - [📧 Contact ](#-contact-)

  - [🔭 Future Features ](#-future-features-)

  - [🤝 Contributing ](#-contributing-)

  - [💖 Show your support ](#-show-your-support-)

  - [🙏 Acknowledgments ](#-acknowledgments-)

  - [📝 License ](#-license-)

# 🧙‍♂️ Math Magicians 

**Math Magicians** is a website that provides users with access to a calculator and a collection of math quotes.

![Screenshot](app_screenshot.png)

## 🛠 Built With 

### Tech Stack 

![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB)

![React Router](https://img.shields.io/badge/React_Router-CA4245?style=for-the-badge&logo=react-router&logoColor=white)

![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white)

![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E)

![HTML5](https://img.shields.io/badge/html5-%23E34F26.svg?style=for-the-badge&logo=html5&logoColor=white)

![CSS3](https://img.shields.io/badge/css3-%231572B6.svg?style=for-the-badge&logo=css3&logoColor=white)

![Jest](https://img.shields.io/badge/-jest-%23C21325?style=for-the-badge&logo=jest&logoColor=white)

![Testing-Library](https://img.shields.io/badge/-TestingLibrary-%23E33332?style=for-the-badge&logo=testing-library&logoColor=white)

![Render](https://img.shields.io/badge/Render-%46E3B7.svg?style=for-the-badge&logo=render&logoColor=white)

### Key Features 

- **Make calculations**

- **Read random Math quotes**

(back to top)


## 🚀 Live Demo 

You can visit the live version of this website on [MathMagicians Webpage](https://math-magicians-oart.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 [Node.js](https://nodejs.org/en/) installed on your machine.

### Setup

Clone this repository to your desired folder:

```sh

  cd my-folder

  git clone git@github.com:IndieCoderMM/math-magicians.git

```

### Install

Install the dependencies with:

```sh

  cd math-magicians

  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 test

```

### Deployment

You can deploy this project using:

```sh

  npm run build

```

This will create a production-ready build of your website in `build/` folder, which you can use to deploy on a static site server.

(back to top)


## 📧 Contact 

I am always looking for ways to improve my project. If you have any suggestions or ideas, I would love to hear from you.

[![Github](https://img.shields.io/badge/GitHub-673AB7?style=for-the-badge&logo=github&logoColor=white)](https://github.com/IndieCoderMM)

[![Twitter](https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white)](https://twitter.com/hthant_oo)

[![Linkedin](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://linkedin.com/in/hthantoo)

[![Gmail](https://img.shields.io/badge/Gmail-D14836?style=for-the-badge&logo=gmail&logoColor=white)](mailto:hthant00chk@gmail.com)

(back to top)


## 🔭 Future Features 

- [x] **Mobile UI**

- [ ] **Add math quotes**

- [ ] **Add calculators**

(back to top)


## 🤝 Contributing 

I welcome any and all contributions to my website! If you have an idea for a new feature or have found a bug, please open an issue or submit a pull request.

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

(back to top)


## 💖 Show your support 

If you like this project, please consider giving it a ⭐.

(back to top)


## 🙏 Acknowledgments 

I would like to thank all code reviewers for making this project better.

(back to top)


## 📝 License 

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

(back to top)