📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 [Math magicians]

[Math magicians] is a react web app for all fans of mathematics. It allows users to: Make simple calculations. Read a random math-related quote.

🛠 Built With

Tech Stack

• HTML
• SCSS
• React

Key Features

• [Components]
• [Events]
• [Refactor with hooks]

(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 to install these prerequisites:

• If you're running on Windows you can download the prerequisites from the links down below:

Nodejs

Git

• If you're running on Linux follow these steps down below:

• Install git.

 sudo apt install git

• Install nodejs and npm.

 sudo apt install nodejs

Setup

Clone this repository to your desired folder:

  git https://github.com/Ndaboom/math-magicians-v3.git
  cd math-magicians-v3

Install

Install this project with:

  npm install

Usage

To run the project, follow below instructions:

• Now you can run the app by executing:

npm start

Run tests

To run tests, run the following command:

  npm test

👥 Authors

👤 Sammy Ndabo

• GitHub: Sammy Ndabo

(back to top)

🔭 Future Features

• Add Home view

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

(back to top)

❓ FAQ

• What version of nodejs does this project works on?

  • The project runs well with nodejs 14+. you might face some issues while running this project in lower versions.

(back to top)

📝 License

This project is MIT licensed.

(back to top)