Skip to content

NatiG25/math-magicians

Repository files navigation

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.
  • Read a random math-related quote.

Screenshot from 2023-07-14 13-24-46

Built With

  • HTML

  • CSS

  • JavaScript

  • React JS

  • Webpack

  • Lighthouse

  • Webhint

  • Stylelint

  • ESlint

Getting Started

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

  • copy this link git@github.com:NatiG25/Math-Magicians.git
  • get the directory that you want to clone the repository.
  • open the command prompt in this directory.
  • write git clone git@github.com:NatiG25/Math-Magicians.git
  • go to the repository folder in your command prompt cd math-magicians
  • use npm install to install the dependencies.
  • use npm start to start live server.

Prerequisites

  • Have a working and updated browser
  • Have a local version control like git install on your computer
  • Have an account and sign in on GitHub, as online/remote version control system
  • Basic knowledge in JS and React JS

Setup

  • Clone the git repo using this command: git clone git@github.com:NatiG25/Math-Magicians.git

Run tests

  • npx hint . : To test html codes
  • npx stylelint "/*.{css,scss}"** : To test css code
  • npx eslint . : To test Eslint Report

To test the application

  • npm install --save-dev jest
  • npm test

Live Demo

Author

Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

  • Microverse linters
  • Coding partners

📝 License

This project is MIT licensed.