📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 Math Magician

"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

HTML, CSS, NodeJS v18, ReactJS

Tech Stack

Structure

• HTML

Style

• CSS

Front-end framwork

• ReactJS

Linters

• Webhint
• Stylelint
• ESLint

Key Features

• Virtual DOM.

• JSX.

• Components.

(back to top)

Live Demo

Live DemO

💻 Getting Started

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

Prerequisites

In order to run this project you need: Open terminal on the same folder of the project and run:

 npm install

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/ritikarawat220/Math-Magicians.git

Install

Install this project with:

  cd Math_magician
  npm install

Usage

Run in development mode (Port 3000)

  npm run start

Build for production

npm run build

Run tests

• Linter Tests

To run tests, run the following command:

To check for html errors run:

  npx hint .

To check for css errors run:

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

To check for js errors run:

  npx eslint "**/*.{js,jsx}"

👥 Authors

👤 Ritika Rawat

• GitHub: ritikarawat220
• Twitter: @ritikarawat22
• LinkedIn: LinkedIn

🔭 Future Features

• Add Components.
• Add Events.

(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 send your feedback to encourage me to do more.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for offering me this opportunity to learn, and practice my skills.

(back to top)

❓ FAQ

-Why use linters?

• The use of linters helps to diagnose and fix technical issues, also linters can help teams achieve a more readable and consistent style, through the enforcement of its rules.

-Why use ReactsJS?

• React has reusable Components.
• React uses Virtual DOM.
• React has a large ecosystem.

(back to top)

📝 License

This project is MIT licensed.

(back to top)