Welcome to my project 😃


Math Magicians

📗 Table of Contents

📖 [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.

By building this application, I improve my skills in using React.

🛠 Built With

Tech Stack

Client

Key Features

  • Easy to the eyes and cultivating at the same time
  • Dynamic creation of content

(back to top)

💻 Getting Started

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

  • Clone this repo as described in the setup section.
  • Make modifications as preferred

Prerequisites

In order to run this project you need: To clone or fork and run it in a browser

Setup

Clone this repository to your desired folder:

Example commands:

  cd my-folder
  git clone https://github.com/berylcl/math-magicians.git

using Ubuntu:

  cd my-desired-folder
  git clone https://github.com/berylcl/math-magicians.git

For more information on how to clone or fork a repository:

Install

  • Run npm install

Usage

To run the project, execute the following command:

  • Run npm start

Run tests

To run tests, run the following command:

  • to test validation errors npx hint .

  • to test CSS linter errors npx stylelint "**/*.{css,scss}"

  • to test JavaScript linter errors npx eslint .

  • to run the jest tests npx test

(back to top)

👥 Author

👤 berylcl

🔭 Future Features

Future changes:

  • Add animations and transitions
  • Add more styles and colors

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

  • Thanks to all Microverse community

(back to top)

📝 License

This project is MIT licensed.

(back to top)