Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

"Math Magicians" is an interactive React website designed for mathematics enthusiasts. It serves as a Single Page App (SPA) where users can perform basic calculations and explore random quotes related to mathematics.
https://github.com/pablobona/math-magicians

boostrap design javascript layout mathematics react

Last synced: 17 days ago
JSON representation

Host: GitHub
URL: https://github.com/pablobona/math-magicians
Owner: PabloBona
Created: 2023-07-03T19:54:23.000Z (over 1 year ago)
Default Branch: dev
Last Pushed: 2023-07-17T04:20:53.000Z (over 1 year ago)
Last Synced: 2024-12-18T16:47:04.585Z (about 1 month ago)
Topics: boostrap, design, javascript, layout, mathematics, react
Language: JavaScript
Homepage: https://math-magicians-bonpa.netlify.app/
Size: 1.05 MB
Stars: 7
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        



 


 Math Magicians

 






  

  

  



# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)

- [📖 Math Magicians (Math-Magicians)](#Math-Magicians)

  - [🛠 Built With ](#-built-with-)

    - [Tech Stack ](#tech-stack-)

    - [Key Features ](#key-features-)

  - [🚀 Live Demo ](#-live-demo-)

  - [💻 Getting Started ](#getting-started)

    - [Install](#-install)

    - [Usage](#-usage)

    - [Run tests](#run-tests)

    - [Deployment](#deployment)

  - [👥 Authors ](#-author-)

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

  - [🤝 Contributing ](#-contributing-)

  - [⭐️ Show your support ](#️-show-your-support-)

  - [🙏 Acknowledgments ](#-acknowledgments-)

  - [❓ FAQ (OPTIONAL) ](#-faq-optional-)

  - [📝 License ](#-license-)

 




# 📖 Math Magicians (Math-Magicians) 

 "Math Magicians" is an interactive React website designed for mathematics enthusiasts. It serves as a Single Page App (SPA) where users can perform basic calculations and explore random quotes related to mathematics.




(back to top)


## 🛠 Built With 

### Tech Stack 

The following stacks were used

  


    HTML

    CSS

    Javascript

    Create React App

 


(back to top)


### Key Features 

- **ReactJS library**

- **Using JSX syntax**

- **Unit test with jest**

- **Boostrap**

(back to top)


### 🚀 Live Demo 

Live Demo




# 💻 Getting Started 

Clone this repository to your desired folder:

Example commands:

```bash

  git clone [email protected]:PabloBona/Math-Magicians.git

```




# 📖 Install

Install this project's dependencies with:

```

cd Math-Magicians

npm install

```




# 📖 Usage

To run the project, execute the following command:

```bash

 npm run start

```

Runs the app in the development mode.\

Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

The page will reload when you make changes.\

You may also see any lint errors in the console.




# Run tests

```bash

  npm test

```




# 📖 Run linterns tests

If you follow the tutorial above to setup linters then you can run these tests

```$

  npx hint .

```

```$

  npx stylelint "**/*.scss"

```

or if you use css then run this instead of the latter command above

```$

  npx stylelint "**/*.{css,scss}"

```




# Available Scripts

In the project directory, you can run:

### `npm start`

Runs the app in the development mode.\

Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

The page will reload when you make changes.\

You may also see any lint errors in the console.

### `npm test`

Launches the test runner in the interactive watch mode.\

See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `npm run build`

Builds the app for production to the `build` folder.\

It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\

Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

### `npm run eject`

**Note: this is a one-way operation. Once you `eject`, you can't go back!**

### Deployment

You can deploy this project using: GitHub Pages or Netlify

(back to top)


### 👥 Author 

- 👤 **Pablo Bonasera**

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

  - LinkedIn: [Pablo Bonasera](https://www.linkedin.com/in/pablo-bonasera-142327257/)

(back to top)


## 🔭 Future Features 

- [ ] **Customizable notifications and alerts**

- [ ] **Multilingual support**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

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

(back to top)


## ⭐️ Show your support 

If you like this project you can follow me on github for more.

(back to top)


## 🙏 Acknowledgments 

- We would like to express our heartfelt gratitude to Microvere for the invaluable learning experience they have provided. The supportive community, dedicated mentors, and remote collaboration opportunities have enhanced my technical skills and prepared me for real-world projects.

(back to top)


## ❓ FAQ (OPTIONAL) 

- **Are the linters necessary?**

  - It is a good practice to install and use them as they guide you towards best practice, but yes you can do without.

(back to top)


## 📝 License 

This project is [MIT](https://github.com/PabloBona/Math-Magicians/blob/setup/create-react-linterns/MIT.md) licensed.

(back to top)