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

https://github.com/salimer/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 quote. By building this application, I improve my skills in using React.
https://github.com/salimer/math-magicians

react scss

Last synced: 11 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: Make simple calculations, and read a random quote. By building this application, I improve my skills in using React.

Awesome Lists containing this project

README

          


logo

Welcome to my project πŸ˜ƒ





Math Magicians


# πŸ“— Table of Contents

- [πŸ“— Table of Contents](#-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)
- [πŸ‘₯ Author ](#-author-)
- [πŸ‘₯ Collaborator ](#-collaborator-)
- [πŸ”­ Future Features ](#-future-features-)
- [🀝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [πŸ™ Acknowledgments ](#-acknowledgments-)
- [πŸ“ 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.
- Read a random quote.

By building this application, I improve my skills in using React.

## πŸ›  Built With

### Tech Stack

Client

### Key Features

- **Easy to the eyes and cultivating at the same time**
- **Dynamic creation of content**

(back to top)

## πŸš€ Live Demo

- [Live Demo Link](https://salimer.github.io/Math-magicians/)

(back to top)

## πŸ’» Getting Started

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

- Clone this repo as described in the setup section.
- Make modifications as preferred

### Prerequisites

In order to run this project you need: To clone or fork and run it in a browser

### Setup

Clone this repository to your desired folder:

Example commands:

```sh
cd my-folder
git clone https://github.com/Salimer/Math-magicians.git
```

using Ubuntu:

```sh
cd my-desired-folder
git clone https://github.com/Salimer/Math-magicians.git
```

For more information on how to clone or fork a repository:
- How to clone a repo
- How to fork a repo

### Install

- Run ` npm install `

### Usage

To run the project, execute the following command:

- Run `npm start`

### Run tests

To run tests, run the following command:

- to test validation errors `npx hint .`

- to test CSS linter errors `npx stylelint "**/*.{css,scss}"`

- to test JavaScript linter errors `npx eslint .`

- to run the jest tests `npx test`

(back to top)

## πŸ‘₯ Author

πŸ‘€ **Salim Bamahfoodh**

- GitHub: [@Salimer](https://github.com/Salimer)

## πŸ‘₯ Collaborator

πŸ‘€ **MartΓ­n Ezequiel GonzΓ‘lez**

- GitHub: [@Mar12358](https://github.com/Mar12358)
- Twitter: [@MarezegonZ](https://twitter.com/MarezegonZ)
- LinkedIn: [Martin Ezequiel Gonzalez](https://www.linkedin.com/in/martin-ezequiel-gonzalez-30a413260/)

## πŸ”­ Future Features

Future changes:
- Add animations and transitions
- Add more styles and colors

(back to top)

## 🀝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Salimer/Math-magicians/issues).

(back to top)

## ⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

## πŸ™ Acknowledgments

- Thanks to all Microverse community

(back to top)

## πŸ“ License

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

(back to top)