kkmanuu/math-magicians

Math magicians" This 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.

📗 Table of Contents

• :List: Math-Magicians

  • 🛠️ Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
  • 👥 Authors
  • 🔭 Future Features
  • ⭐️ Show your support
  • 🤝 Contributing
  • 🙏 Acknowledgments
  • 📝 License

  📖 Math-Magicians

  • Math magicians" This 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

Tech Stack

• HTML
• CSS
• JAVASCRIPT
• React

(back to top)

Key Features

• Use React Router.
• Use styles in a React app.

(back to top)

🚀 Live Demo

Click here

💻 Getting Started

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

Prerequisites

In order to run this project you need the following:

• A web browser to view output e.g Google Chrome.
• An IDE e.g Visual studio code.
• node should be installed in your local machine, node website.
• Install the npm package manager use this to install both node and npm.
• A terminal.

Setup

• Navigate to the location of the folder in your machine

Install

To install all dependencies, run:

npm install

Usage

Because this project uses webpack as a bundler, to run the project, execute the following command:

• npm run start

• OR

• npm start

Run tests

To run tests, run the following command:

• Track HTML linter errors run

npx hint .

• Track CSS linter errors run:

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

• Track JavaScript linter errors run:

npx eslint .

Usage

To run the project, follow these instructions:

• After Cloning this repo to your local machine.
• Open the index.html in your browser.

Run tests

To run tests, run the following command:

• Track HTML linter errors run:

npx hint .

• Track CSS linter errors run:

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

• Track JavaScript linter errors run:

npx eslint .

Deployment

• Deployed with github pages
• For more information about publishing sources, see "About GitHub pages".

(back to top)

👥 Authors

👤 Emmanuel Kipngeno

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

🔭 Future Features

• Use React Router.
• Use styles in a React app.

(back to top)

⭐️ Show your support

If you like this project give start.

(back to top)

🤝 Contributing

Contributions, issues page issues, and feature requests are welcome!

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for this opportunity.

(back to top)

📝 License

This project is MIT licensed.

(back to top)