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

📖 [Math Magicians]

[Math Magicians] Is my first react project.

🛠 Built With

1. ✅ React

Tech Stack

Markup

• HTML
• MD markup

Style

• CSS

Dynamic

• JavaScript
• React
• WepPack

Key Features

• 🔰 [React-based project]
• 🔰 [Well Code structure]
• 🔰 [Responsive]

(back to top)

🚀 Live Demo

• ✅ Click here to see the project

(back to top)

💻 Getting Started

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

1. Download or clone this repostory.
2. Provide a modern web browser.

Prerequisites

In order to run this project you need:

• ✔ Git installed in your machine.
• ✔ Sign in or sign up to your Github account.
• ✔ A professional editer such as VS Code.
• ✔ An Updated web browser such as Google Chrome, you can download it from here.
• ✔ Node.js installed in your machine.
• ✔ Stylelint
• ✔ ESLint
• ✔ WebPack

npm init -y
npm install --save-dev hint@7.x
npx hint .

• ✔ Stylelint

npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x

• ✔ ESLint

npm install --save-dev eslint@7.x eslint-config-airbnb-base@14.x eslint-plugin-import@2.x babel-eslint@10.x

Setup

• Clone this repository to your desired folder:

• Example commands:

  cd [YOUR FOLDER]
  git clone https://github.com/sadaf-Daneshgar/math-magicians.git

Install

• Run the following command in the root directory of the project to install all dependecies.

  npm install

Usage

• To run the project, execute the following command:

 cd [YOUR FOLDER]
 git clone https://github.com/sadaf-Daneshgar/math-magicians.git

Run tests

1. Stylelint

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

2. ESLint ☑

npx eslint .

Deployment

This project is deployed by the author, no permission for deployment by any other client.

(back to top)

👥 Authors

👤 Sadaf Daneshgar

• 👤 GitHub: @Sadaf-Daneshgar
• 👤 Twitter: @SadafDaneshgar
• 👤 LinkedIn: Sadaf Daneshgar

👤 Evans Nyamekye

• 👤 GitHub: evansnyamekye
• 👤 Twitter: @nyamekye2131
• 👤 LinkedIn: Evans Kofi Nyamekye

(back to top)

🔭 Future Features

• [Unit test]
• [Responsive]
• [Deployment]
• [Use developer local storage]

(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, kindly drop a start for the repository;

(back to top)

🙏 Acknowledgments

I would like to thank the following individuals and organizations for their contribution to this project.

• I would like to express my heartfelt gratitude to Microvere for the invaluable learning experience they have provided.

(back to top)

📝 License

This project is MIT licensed.

(back to top)