wineshuga / 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.

Math Magicians

📗 Table of Contents

• 📗 Table of Contents
• 📖 Math Magicians
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
  • 👥 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.
• Read a random math-related quote.

🛠 Built With

Tech Stack

Client

• React.js

Key Features

• Make simple calculations
• Read a random math-related quote

(back to top)

🚀 Live Demo

• Click here to view

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

 npm install

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/Wineshuga/math-magicians.git

Install

Install this project with:

  cd my-project
  npm install

Usage

To run the project:

• Go to /src/components/Quotes.js.
• Replace API key with yours in a .env file.
• Then, execute the following command:

   npm start

Run tests

To run tests, run the following command:

   npm run test

(back to top)

👥 Authors

👤 Author1

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Full website setup
• Fetch data from API
• Functional components

(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, please give it a Star⭐️

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for inspiring this project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)