majdalkilany / math-magicians

Math-Magicians

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
  • Tech Stack
  • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support -- 🙏 Acknowledgements
• 📝 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

Javascript React.js CSS

Key Features

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

(back to top)

🚀 Live Demo

See the Math-Magician project here

💻 Getting Started

Running this project on your computer.

To get a local copy up and running, follow these steps:

• Clone this repository run git clone https://github.com/majdalkilany/math-magicians

• Follow the steps in Setup below

Prerequisites

In order to run this project you need:

• A GitHub account
• Node JS
• Visual Studio Code or any other code editor of your preference
• Web browser

Setup

Make a new directory in your local computer. To do this:

• run mkdir <directory-name>
• change the location to the directory you created run cd <directory-name>
• Follow the steps in Install below

Install

To Install this project, follow the steps below:

• Clone this repository run git clone https://github.com/majdalkilany/math-magicians

• run cd math-magicians

• run npm start

The project will open on your default browser. Interact with the project :)

(back to top)

👥 Authors

👤 Author - Majd Alkilany

• GitHub: (https://github.com/majdalkilany)
• LinkedIn: (https://www.linkedin.com/in/majdalkilany/)

(back to top)

🔭 Future Features

• Mobile version of the appication
• A contact page
• A reservation functionality

(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, kindly leave a comment below and share it with someone who enjoys coding! And also give it star, and follow us on github for more :(

(back to top)

🙏 Acknowledgments

• We'd like to thank microverse for providing the project requirements, linting tools, webpack configuration and kanban board template.

(back to top)

📝 License

This project is MIT licensed.

(back to top)

(back to top)