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
• License

[Math magicians]

A single page react application where users can make mathematical calculations with basic mathematical operators.

Built With

Tech Stack

• React JS
• Tailwind CSS

Key Feature

• Calculator application
• Phrase generator app

Live Demo

Coming soon!

• Math Magician

Getting Started

To get the content of this project locally you need to run the following commands in your terminal.

Prerequisites

• IDE (code editor) like: VScode, Sublime, etc
• Git

Setup

1. Download the Zip file or clone the repo with:

git clone https://github.com/shafiuyushawu/math-magician

2. To access cloned directory run:

cd math-magicians

Install

To install linters and other project's dependencies run:

npm install

Usage

To run the project, execute the following command:

• Excute below command in the terminal to serve live

npm start

Run Test for Linters

For tracking linter errors locally you need to follow these steps:

1. For tracking linter errors in HTML files run:

npx hint .

2. For tracking linter errors in CSS or SASS files run:

npx stylelint "\*_/_.{css,scss}"

3. For tracking linter errors in JavaScript files run:

npx eslint .

Deployment

You can deploy this project using:

• GitHub pages: Live
• Vercel

Author:

Authors

Shafiu Ibn Yushawu

• GitHub: @shafiuyushawu
• Twitter: @shafiuyushawu

Future Features

• Responsiveness for mobile version
• Calculator UI

Contributing

Contributions, issues, and feature requests are welcome!

Kindly raise issue here

Show your support

If you like this project, kindly follow me on GitHub

Acknowledgments

• I would like express my sincere appreciation to Microverse for coming out with these curriculum of project.

License

This project is MIT licensed.