📗 Table of Contents

• 📖 About the Project
  • Tech Stack
  • Key Features

• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Math Magician

Math Magician This is the first project of the Math Magicians application. I have set up the environment and tools needed to develop a React application. In the following projects, I will develop the actual application.

Tech Stack

Client

• HTML and CSS
• JavaScript
• React

Key Features

• React App
• JSX
• SPA

(back to top)

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need:

1. git
2. VS Code or any code editor
3. npm intalled

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:rubydevi/math-magician.git
  cd math-magician

Install

Install this project with:

Stylelint

1. Run this code:

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

2. Don't forget to copy .stylelintrc.json to the root directory of your project.

ESLint

1. Run this code:

 npm install --save-dev eslint@7.x eslint-config-airbnb@18.x eslint-plugin-import@2.x eslint-plugin-jsx-a11y@6.x eslint-plugin-react@7.x eslint-plugin-react-hooks@4.x @babel/eslint-parser@7.x @babel/core@7.x  @babel/plugin-syntax-jsx@7.x  @babel/preset-react@7.x @babel/preset-react@7.x

2. Don't forget to copy .eslintrc.json to the root directory of your project.

Usage

To run this project in the browser, simply open the index.html file in your preferred browser by running the code below in your terminal:

 npm start

Run tests

To run tests, run the following command:

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

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

(back to top)

👥 Authors

👤 Chongtham Ruby Devi

• GitHub: @rubydevi
• Twitter: @arieabyss
• LinkedIn: Chongtham Ruby Devi

(back to top)

🔭 Future Features

• Calculator
• More Forms

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ Show your support

If you like this project please leave a star, I'd really appreciate it.

(back to top)

Acknowledgments

• I'd like to thank Microverse for this wonderful README template.

📝 License

This project is MIT licensed.

(back to top)