10-menachi/math-magicians

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 (OPTIONAL)
• 📝 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.
• View the app's description.

🛠 Built With

Tech Stack

Client

• React.js

Server

No server side technologies were used in this project.

Database

No database technologies were used in this project.

Key Features

• Calculator: perform basic math operations.
• Quote: read a random math-related quote.
• Home: read a description of the app and instructions on how to use it.

(back to top)

🚀 Live Demo

Coming soon...

(back to top)

💻 Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

In order to run this project you need:

• Stylelint
• ESLint
• Node JS
• Node package Manager (NPM) OR Yarn

Install

Follow the link below to install Node JS

• Node JS

Follow the link below to install NPM

• NPM

Follow the link below to install Yarn

• Yarn

Once you have installed Node JS and NPM or Yarn, install the following packages globally:

  npm install -g stylelint
  npm install -g eslint
  npm install -g webpack

OR if on Yarn,

  yarn global add stylelint
  yarn global add eslint
  yarn global add webpack

However, whilst everything is included in the package.json file, you can simply run:

  npm install

OR if on Yarn,

  yarn install

Don't know how to use Package Managers? Check out the Beginner's Guide

Setup

Clone this repository to your desired folder:

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

Usage

To run the project:

  cd math-magicians
  npm run start

OR if on Yarn,

  cd math-magicians
  yarn start

The website is hosted on localhost:3000 by default.

To change the port to the port of your choice, run:

  npm run start -- --port=YOUR_PORT

Wanna learn more about React? Check out the React Documentation

Run tests

There are no tests for this project

(back to top)

👥 Authors

👤 Christian Timbe

• GitHub: @10-menachi
• Twitter: @christian_timbe
• LinkedIn: chris-droid

(back to top)

🔭 Future Features

• Complex math operations: perform complex math operations.

(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, feel free to fork it and give it a ⭐️!

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for the great learning opportunity they are giving me with this project.

(back to top)

(back to top)

📝 License

This project is MIT licensed.

(back to top)