Math-Magicians

A single Page Application Calculator built using React js

Math Magicians

📗 Table of Contents

• Math-Magicians
• 📗 Table of Contents
• 📖 Math Magicians
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ (OPTIONAL)
  • 📝 License

📖 Math Magicians

Math Magicians is a Single Page Application developed using React and Redux. We use the create-react-app build tool for development. The core component of the project is a calculator component that allows users to perform arithmetic operations.

🛠 Built With

Tech Stack

Client

• React.js

Key Features

• Interactive Calculator
• Math quotes

(back to top)

🚀 Live Demo

• Live Demo Link

(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 the following installed in your local machine:

• Node.js
• git

Setup

Clone this repository to your desired folder:

Example commands:

  cd <desired-folder>
  git clone git@github.com:Rachelwebdev/math-magicians.git
  cd math-magicians

Install

Install this project with:

Example command:

  npm install

The above command installs necessary node modules used in the project

Usage

To run the project, execute the following command:

Example command:

  npm run start

The above command opens the project webpage in your browser.

Run tests

To run tests, run the following command:

Example command:

npm run test

The above command runs jest test suites in the project

Deployment

You can deploy this project using:

Example:

npm run build

The above command produces build files that can be deployed using Github pages or any other hosting service.

(back to top)

👥 Authors

👤 Rachel Isaac

• GitHub: @rachelwebdev
• Twitter:@rachelisaac13
• LinkedIn: Rachel Isaac

(back to top)

🔭 Future Features

• Mobile version
• Responsive webpage

(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 a Star to the github repo.

(back to top)

🙏 Acknowledgments

To be updated at the end of the project

I would like to thank...

(back to top)

❓ FAQ (OPTIONAL)

• How to report bugs?

  • Please raise github issue with more details about the bug.

• What is the licensing policy of the project?

  • The project is MIT licensed, please refer to the License section

(back to top)

📝 License

This project is MIT licensed.

(back to top)