ProgramKingAbel/math-magician-app

[Maths-Magicians] is a website for all fans of mathematics. It is a Single Page App (SPA) that allows users to: Make simple calculations and Read a random math-related quote.

Math Magicians

📗 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

📖 [Maths- Magicians]

[Maths-Magicians] is a website for all fans of mathematics. It is a Single Page App (SPA) that allows users to: Make simple calculations and Read a random math-related quote.

🛠 Built With

Tech Stack

• Client
  • React

Key Features

• [USED REACT LIBRARY]

(back to top)

🚀 Live Demo

• [Live Demo Link - Yet to be released]
• [Introduction to Project -Yet to be released]

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

• A browser of you choice.
• A text editor of your choice.
• An installed node.js on your local system

Setup

Clone this repository to your desired folder:

• Use the following Commands:

  cd your-desired-folder
  git clone git@github.com:ProgramKingAbel/math-magician-app.git
  

Install

Install this project with:

• You can deploy this projec on hosting provider of your choise or you can deploy it on github pages.

Usage

• Use following commands to run on your local system:

  npm run build
  npm run dev
  

Run tests

• Run the following script and style test:

  npm test
  npx eslint "**/*.{js,jsx}"
  npx stylelint "**/*.{css}"
  

Deployment

You can deploy this project using:

• Free deployment services like GitHub pages.
• Any deployment services of your choice.

(back to top)

👥 Authors

👤 Abel Matunda Morara

• GitHub: @ProgramKingAbel
• Twitter: @CEOAbel1
• LinkedIn: C.E.O Abel Matunda Morara

(back to top)

🔭 Future Features

• [Add Live version]

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

(back to top)

🙏 Acknowledgments

We would like to thank Microverse and our coding partners.

(back to top)

❓ FAQ

• How to make it mobile friendly?

  • Put a viewport tag in the header

• How to design the site?

  • Draw a mockup before start to code

(back to top)

📝 License

This project is MIT licensed.

(back to top)