README.md

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
    • Future Features
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • Deployment
  • Test
• 👥 Authors
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Math-magicians

Math-magicians is a website for all fans of mathematics. It is a Single Page App (SPA) that allows users to make simple calculations and read a random math-related quote.

🛠 Built With

Tech Stack

Client

• HTML
• CSS
• JavaScript ES6
• React

Key Features

• Calculator that performs all math operations
• Fetch data from API

(back to top)

Future Features

• Implement a CSS Preprocessor.

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

• Install Git on your computer Git
• Any text editor like VSCode
• Install linters on your local environment

Setup

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

1. Clone the repository: git clone https://github.com/kambereBr/math-magicians.git
2. Navigate to the project directory: cd math-magicians

Install

Install npm:

npm install

npm run build

Usage

Inside your IDE:

  npm start

Deployment

You can deploy this project using: GitHub Pages

Test

In order to follow the Linters you could check them using this:

HTML Checker:
npx hint .

CSS Checker:
npx stylelint "**/*.{css,scss}"

JavaScript Checker:
npx eslint .

Note

Use at the end '--fix' to help you out with any error.

👥 Author

👤 Bruno Kambere

• GitHub: @kambereBr
• Twitter: @kambereBr
• LinkedIn: bruno kambere

(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 feel free to watch it and take some features that will enhance your project as well.

(back to top)

🙏 Acknowledgments

I would like to thank the Microverse Team for reviewing my code and making me a better professional.

(back to top)

📝 License

This project is MIT licensed.

(back to top)