Simpleshaikh1/math-magician

Math Magicians

📗 Table of Contents

• 📗 Table of Contents
• 📖 Math Magicians
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 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, and read a random math-related quote.

🛠 Built With

Tech Stack

Text Editor

• Visual Studio Code

Client

• HTML
• JavaScript

Style

• CSS

Bundle

• Webpack

Test

• Jest

Key Features

• Fetch and send data to an API
• Save and retrieve Likes, Comments, and Reservations
• Testing Using Jest

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

• Browser
• Code Editor
• Node.js

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:Simpleshaikh1/math-magician.git

Install

Install this project with:

  cd my-project
  npm install

Usage

To run the project, execute the following command:

  npm start

Run tests

To run tests, run the following command:

  npm test

Deployment

You can deploy this project using:

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

(back to top)

👥 Authors

👤 Toyyib Bello

• GitHub: @simpleshaikh1

• Site: @simpleshaikh1

(back to top)

🔭 Future Features

• Add Events.
• Refactor with hooks.
• Deploy the website.

(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

I would like to thank Microverse and my Coding Partners.

(back to top)

📝 License

This project is MIT licensed.

(back to top)