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

https://github.com/eccb7/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.
https://github.com/eccb7/math-magicians

css javascript jest jest-snapshots react

Last synced: about 1 month 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 and 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)
- [Project Walkthrough](#walkthrough)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 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
- **HTML5**
- **CSS3**
- **React**
### Key Features

- **Simple calculations**: User can do simple mathematics calculations and find their solutions.

- It also has random math quotes to psych up users.

(back to top)

## 🚀 Live Demo

- [Live Demo Link](https://math-magicians-gray.vercel.app)

(back to top)

## 💻 Getting Started

### Prerequisites

To run this project, you need the following:

- 🌐 Web browser
- 🐙 Git
- 👨‍💻 Code editor

### Setup

Clone this repository to your desired folder:

```bash
git clone https://github.com/Eccb7/Math-Magicians.git
```

### Install

To install all dependencies, run the following command:

```bash
npm install
```

### Run Tests

To run tests, use the following commands:

- To track CSS linter errors, run:
```bash
npx stylelint "**/*.{css,scss}"
```
- To track JavaScript linter errors, run:
```bash
npx eslint "**/*.{js,jsx}"
```

### Build

To build the project, run the following command:

```bash
npm run build
```

### Webpack Development Server

To run the webpack development server, execute the following command:

```bash
npm start
```

(back to top)

## 👥 Author

👤 **Ojwang Briton**

- GitHub: [@Eccb7](https://github.com/Eccb7)
- Twitter: [@briton_otieno4](https://twitter.com/briton_otieno4)
- LinkedIn: [briton-otieno-ba6591244](https://linkedin.com/in/briton-otieno-ba6591244)

👤 **Lala Aicha El Vadel**

- GitHub: [@Eccb7](https://github.com/leloufadel)
- Twitter: [@briton_otieno4](https://twitter.com/leloufadel)
- LinkedIn: [briton-otieno-ba6591244](https://www.linkedin.com/in/lala-aicha-el-vadel-8563a6202/)

(back to top)

## 🔭 Future Features

- [ ] **Improve User Interface for smooth transitions and animations**
- [ ] **Introduce more complex math functions to be used by users**

(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 reach me through [@briton_otieno4](https://twitter.com/briton_otieno4) and share more thoughts to help improve

If you like this project, give it a ⭐️.

(back to top)

## 🙏 Acknowledgments

I would like to thank Microverse for the support I've received so far.

(back to top)

(back to top

## 📝 License

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

(back to top)