📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 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 math-related quote.

Built With

• React.js
• VSCode and GitHub

Tech Stack

Client

• React.js

• HTML

• SASS

Server

• N/A

Database

• N/A

(back to top)

Key Features

• [Git Flow]
• [Best practices for JavaScript]

(back to top)

Live Demo

Live Demo Link

💻 Getting Started

Clone this repository to get started with the project, make sure to configure linters by following the instructions in the Linters README file

Prerequisites

In order to run this project you need:

• A working computer.
• Connection to internet.
• npm and Node.js installed, if you don't have them, please follow this simple installation guide.

Setup

• Clone the folder to your local machine.
• Open a local copy of the project in your code editor.

(back to top)

Usage

• To run the project, execute the following command:

  • npm start in your terminal.

• To run test functions, execute the following command:

  • npm test in your terminal.

(back to top)

Run tests

• After pushing the changes on github, merge your pull request and let github action process changes and fix errors, if any.
  • For stylelint errors run:sudo npx stylelint "*/.{css,scss}" --fix for automatic fix.
  • For ESLINT errors run:npx eslint "**/*.{js,jsx}" --fix for automatic fix.

(back to top)

👥 Authors

👤 Ashmal Zahra

• GitHub: @ashmalzahra
• Twitter: @AshmalZahraa
• LinkedIn: ashmal-zahra

(back to top)

🔭 Future Features

• Deployment

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for the information provided to build this project.

(back to top)

❓ FAQ (OPTIONAL)

• Can I use the project for any purpose?

  • Yes, you can.

• Is the information saved in any database?

  • No, all data is saved in Local Storage.

(back to top)

📝 License

This project is MIT licensed.

(back to top)