https://github.com/mailsg/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 and read a random math-related quote.
https://github.com/mailsg/math-magicians

html-css-javascript reactjs

Last synced: 7 days 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 and read a random math-related quote.

• Host: GitHub
• URL: https://github.com/mailsg/math-magicians
• Owner: mailsg
• License: mit
• Created: 2023-06-05T10:44:22.000Z (over 1 year ago)
• Default Branch: development
• Last Pushed: 2023-06-15T12:37:21.000Z (over 1 year ago)
• Last Synced: 2024-12-08T14:41:27.475Z (2 months ago)
• Topics: html-css-javascript, reactjs
• Language: JavaScript
• Homepage: https://math-magicians-ysof.onrender.com
• Size: 2.1 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 📗 Table of Contents

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

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

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

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

  - [👩‍💻 Presentation](#Presentation)

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

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

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

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ (OPTIONAL)](#faq)

- [📝 License](#license)

# 📖 Math Magicians App 

**Math Magicians App** 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

  


    
Javascript

  


  ReactJS

  


    
ReactJS

  


### Key Features 

- **Interactive Webpage**

- **Calculator Functions**

- **API Interaction for Quotes**

- **Webpack**

(back to top)


## 🚀 Live Demo 

You can checkout the live demo below 👍

https://math-magicians-ysof.onrender.com/

(back to top)


## 💻 Getting Started 

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

### Prerequisites

In order to run this project you need:

- a browser

- git

- nodejs

### Setup

Clone this repository to your desired folder:

```sh

  cd my-folder

  git clone [email protected]:mailsg/Math-Magicians.git

```

### Install

Install this project with:

```sh

  cd Math-Magicians

  npm install

  npm run build

  npm start

```

### Usage

To run the project, execute the following command:

```sh

  Open dist/index.html in browser

  or

  Open with Live server in Vscode

```

### Run tests

To run tests, run the following command:

```sh

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

  npx hint .

  npx eslint "**/*.{js,jsx}"

```  

(back to top)


## 👥 Author 

👤 **Sandeep Ghosh**

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

(back to top)


## 🔭 Future Features 

- [ ] **Profile Section**

- [ ] **News Section**

- [ ] **Join Section**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [https://github.com/mailsg/Math-Magicians/issues](../../issues/).

(back to top)


## ⭐️ Show your support 

If you like this project give me a follow and/or a star

(back to top)


## 🙏 Acknowledgments 

I would like to thank Microverse for giving this opportunity to me to showcase my dev skills.

(back to top)


## 📝 License 

This project is [MIT](./LICENSE) licensed.

(back to top)