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
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ (OPTIONAL)
  • 📝 License

📖 Math-Magicians

Math-Magicians is a single-page application (SPA) that allows users to make simple calculations and read a random math-related quote.

🛠 Built With

• HTML
• CSS
• JavaScript
• React
• Webpack

Tech Stack

Key Features

• Single Page Application

• Make simple calculations

• Displays a math_related quote

  (back to top)

🚀 Live Demo

• Live demo

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

• node.js
• git
• gitHub account
• VSCode (or another code editor);
• modern browser (supporting HTML5 and CSS3) is highly recommended

Setup

Clone this repository to your desired folder:

• Open your terminal

• Navigate to the directory where you want to clone the project.

• Clone the project using by running the following command:

git clone https://github.com/yusufyusie/Math-Magicians.git

Install

Install this project using the following command:

npm install.

Usage

To run the project, execute the following commands:

• This project was bootstrapped with Create React App.

  To install all dependencies run the following command:

• npm install

• npm run build

• npm start

Run tests

To run tests, run the following command:

npm test

To run Stylelint and ESLint tests, run the following commands respectively:

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

npx eslint .

Deployment

You can deploy this project using:

(back to top)

👥 Authors

👤 Yesuf Fenta

• GitHub: @yusufyusie
• Twitter: @yusufyusiee
• LinkedIn: yusufyusie

(back to top)

🔭 Future Features

• Scientific calculation feature can be added
• Neumorphism style on calculator can be added

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

• I would like to thank
  • 

(back to top)

❓ FAQ (OPTIONAL)

• How to fix JavaScript + CSS + HTML linter errors?

  • Kindly use the following in your project's root directory:

  npx stylelint "**/*.{css,scss} --fix"
  

  npx eslint . --fix
  
  

(back to top)

📝 License

This project is MIT licensed.

(back to top)