Math Magicians

📗 Table of Contents

• 📗 Table of Contents
• 📖 Math Magicians (Math-Magicians)
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ (OPTIONAL)
  • 📝 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:

  git clone git@github.com: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:

 npm run start

Runs the app in the development mode.
Open 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

  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 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 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 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
  • LinkedIn: Pablo Bonasera

(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.

(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 licensed.

(back to top)