Maths-magicians

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Run tests
• 👥 Authors
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

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

🛠 Built With

Tech Stack

• HTML

• CSS

• Javascript

• React

• Webpack

• NPM

• Lighthouse (An open-source, automated tool for improving the quality of web pages. It has audits for performance, accessibility, progressive web apps, SEO and more).

• Webhint (A customizable linting tool that helps you improve your site's accessibility, speed, cross-browser compatibility, and more by checking your code for best practices and common errors).

• Stylelint (A mighty, modern linter that helps you avoid errors and enforce conventions in your styles).

Client

• React.js

Server

• Express.js

Database

• PostgreSQL

Key Features

• Make simple calculations.
• Read a random math-related quote.

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

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

• npm

  npm install npm@latest -g

Setup

1. Clone the repo by running the command

    git clone https://github.com/PeteUgwu/Maths-magicians

2. Open the directory of the project

   cd Maths-magicians

3. Install project dependencies

   run npm install

4. Open the html file

   run npm start
   
   

Run tests

To run tests, run the following command:

• npm

  npm test

(back to top)

👥 Author

👤 Author

• GitHub: @PeteUgwu
• Twitter: @Petrus4Charles
• LinkedIn: /peter-ugwu-15a3a724b/

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Write a message to encourage readers to support your project

If you like this project...

(back to top)

🙏 Acknowledgments

Give credit to everyone who inspired your codebase.

(back to top)

Show your support

• Give a ⭐️ if you like this project!

(back to top)

📝 License

• This project is MIT licensed.

(back to top)