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

https://github.com/tresorsawasawa/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/tresorsawasawa/math_magicians

javascript react sass webpack

Last synced: 2 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 math-related quote.

Awesome Lists containing this project

README

          

# Math magicians

This project has been bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

![math-magicians](./src/images/math_magicians.png)

## Built With

This project is built with:

- ![React](https://img.shields.io/badge/-React-000000?style=flat&logo=react)
- ![Sass](https://img.shields.io/badge/-Sass-000000?style=flat&logo=sass&logoColor=ffffff&labelColor=%23CC6699)
- ![JavaScript](https://img.shields.io/badge/-JavaScript-000000?style=flat&logo=javascript)

## Live Demo

Click [here](https://tresorsawasawa.github.io/math_magicians/) to see the live demo

## Getting Started

To get the content of this project locally you need to run this command in your terminal:

### Preriquiresites

First make sure you have the following tools in local machine:

- [Git](https://www.linode.com/docs/guides/how-to-install-git-on-linux-mac-and-windows/)
- [Node.js](https://nodejs.dev/learn/how-to-install-nodejs)
- IDE(e.g.: Vscode, Sublime,...)

### Setup

1. Clone the repo
```
git clone hhttps://github.com/tresorsawasawa/math_magicians.git
```
2. Access the cloned the repo
```
cd math_magicians
```

### Install

- To install all the dependancies of the project:
```
npm install
```
- Create the production mode
```
npm run build
```
- Run the app locally
```
npm start or npm run start
```

## Test

For tracking linter errors locally you need to follow these steps:

- After cloning the project make sure you have run this command

> `npm install` command

- For tracking the linter errors in HTML file run:

> `npx hint .`

- For tracking the linterj errors in CSS file run:

> `npx stylelint "\*_/_.{css,scss}"`

- And For tracking the linter errors in JavaScript file run:

> `npx eslint .`

- Use `npm run build` to run the app in live server

## Author

👤 **Tresor Sawasawa**

- GitHub: [@tresorsawasawa](https://github.com/tresorsawasawa)
- Twitter: [@tresorsawasawa](https://twitter.com/TresorSawasawa)
- LinkedIn: [Trésor Sawasawa](https://www.linkedin.com/in/tr%C3%A9sor-sawasawa-43745320b/)

## :handshake: Contributing

Feel free to check the [issues page](https://github.com/tresorsawasawa/math_magicians/issues)

## Show your support

Give a :star: if you like this project!

## Acknowledgments

- Thanks to everyone who will get time to check this code especially to code reviewers.

## 📝 License

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