📗 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
• 📝 License

📖 React Template

Describe your project in 1 or 2 sentences.

React Template is a ...

🛠 Built With

Tech Stack

React

Client

• React.js

Key Features

Describe between 1-3 key features of the application.

• [key_feature_1]
• [key_feature_2]
• [key_feature_3]

(back to top)

🚀 Live Demo

Add a link to your deployed project.

• 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:

In order to run this project you need:

• Basic Knowledge of HTML, CSS, & JavaScript.
• Basic knowledge of ES6 syntax.
• Basic knowledge of Git, GitHub &Gitflow.
• Basic knowledge of Linters.
• Basic knowledge of Webpack.
• Basic Knowledge of React
• Basic knowledge of Jest unit-testing library.
• Basic knowledge of VS Code or any other code-editors.

Setup

Clone this repository to your desired folder:

Clone this repository to your desired folder:

  cd Math-Magician
  git clone https://github.com/jonathanmunamire/Math-Magician.git

Install

Install this project with:

  npm install

Usage

To run the project, execute the following command:

  npm run dev

Run tests

To run tests, run the following command:

  npm run test

Deployment

You can deploy this project using:

  npm run deploy

(back to top)

👥 Authors

👤 Author

• GitHub: @jonathanmunamire
• Twitter: @amanimunamire
• LinkedIn: Jonathan Munamire

(back to top)

🔭 Future Features

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Write a message to encourage readers to support your project

If you like this project...

(back to top)

🙏 Acknowledgments

Give credit to everyone who inspired your codebase.

I would like to thank...

(back to top)

❓ FAQ

Add at least 2 questions new developers would ask when they decide to use your project.

• [Question_1]

  • [Answer_1]

• [Question_2]

  • [Answer_2]

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)