https://github.com/peteugwu/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.
https://github.com/peteugwu/maths-magicians

css javascript pwa react reactjs

Last synced: 2 months ago
JSON representation

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.

• Host: GitHub
• URL: https://github.com/peteugwu/maths-magicians
• Owner: PeteUgwu
• License: mit
• Created: 2022-12-07T14:37:55.000Z (about 2 years ago)
• Default Branch: dev
• Last Pushed: 2023-01-10T13:27:41.000Z (almost 2 years ago)
• Last Synced: 2024-10-03T13:22:21.002Z (3 months ago)
• Topics: css, javascript, pwa, react, reactjs
• Language: JavaScript
• Homepage: https://react-math-magicians.onrender.com
• Size: 1.01 MB
• Stars: 7
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Maths-magicians



# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  - [🚀 Live Demo](#live-demo)

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Run tests](#run-tests)

- [👥 Authors](#authors)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#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](https://react-math-magicians.onrender.com/)

(back to top)


## 💻 Getting Started 

> 

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

- npm

  ```sh

  npm install npm@latest -g

  ```

### Setup

1. Clone the repo by running the command

   ```sh

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

   ```

2. Open the directory of the project

   ```sh

   cd Maths-magicians

   ```

3. Install project dependencies

   ```sh

   run npm install

   ```

4. Open the html file

   ```sh

   run npm start

### Run tests

To run tests, run the following command:

- npm

  ```sh

  npm test

  ```

(back to top)


## 👥 Author 

👤 **Author**

- GitHub: [@PeteUgwu](https://github.com/PeteUgwu)

- Twitter: [@Petrus4Charles](https://twitter.com/Petrus4Charles)

- LinkedIn: [/peter-ugwu-15a3a724b/](https://www.linkedin.com/in/peter-ugwu-15a3a724b/)

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/PeteUgwu/Maths-magicians/issues).

(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](https://github.com/PeteUgwu/Maths-magicians/blob/dev/LICENSE) licensed.

(back to top)