README.md

Math Magicians

📗 Table of Contents

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

🛠 Built With

Tech Stack

Client

• React

Server

• Webpack

Database

None.

Key Features

• [Make Calculations]
• [Show maths quotes]

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need: Node LTS installed

Setup

Clone this repository to your desired folder using the below command:

  cd my-folder
  git clone [email protected]:flemton/math-magicians.git

Install

Install this project with:

  cd math-magician
  npm i

Usage

To run the project, execute the following command:

  npm start

Run tests

To run tests, run the following command:

  npx eslint .

👥 Author

👤 Author

• GitHub: @flemton
• Twitter: @oalhassan847
• LinkedIn: Alhassan Osman

(back to top)

🔭 Future Features

• [Solve BigInt calculations]

(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, considering giving it a star

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for giving me this project to work on

(back to top)

📝 License

This project is MIT licensed.