Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ab-noori/math-magicians

"Math magicians" is a website for mathematics fans. It is a Single Page App (SPA) created using ReactJS library, that allows users to make simple calculations and read a random math-related quote.
https://github.com/ab-noori/math-magicians

babel components external-api html-css-javascipt html-css-javascript html5 jest-tests props quote-api react-hooks reactjs scss useeffect usestate

Last synced: 8 days ago
JSON representation

"Math magicians" is a website for mathematics fans. It is a Single Page App (SPA) created using ReactJS library, that allows users to make simple calculations and read a random math-related quote.

Host: GitHub
URL: https://github.com/ab-noori/math-magicians
Owner: ab-noori
License: mit
Created: 2023-04-06T16:31:15.000Z (over 1 year ago)
Default Branch: dev
Last Pushed: 2023-05-27T17:45:20.000Z (over 1 year ago)
Last Synced: 2024-10-11T06:51:43.714Z (26 days ago)
Topics: babel, components, external-api, html-css-javascipt, html-css-javascript, html5, jest-tests, props, quote-api, react-hooks, reactjs, scss, useeffect, usestate
Language: JavaScript
Homepage: https://ab-noori.github.io/math-magicians
Size: 2.95 MB
Stars: 19
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        

![](https://img.shields.io/badge/Microverse-blueviolet)





> # Math Magicians

| Desktop Veiw Representation|

|---------------------------------------|

|
|

||

|
|

# 📗 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)

  - [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] 

> **[Math Magicians]** is a website for mathematics fans. It is a Single Page App (SPA) that allows users to make simple calculations and read a random design-related quote.

## 🛠 Built With 

### Tech Stack 

- Client

    


      HTML

      CSS

      JavaScript

      ReactJS

      API

    


### Key Features 

- **[Responsive layout]**

- **[UX/UI accessibility]**

- **[Dynamic data]**

(back to top)


## 🚀 Live Demo 

> - [Live Demo on Gh-pages](https://ab-noori.github.io/math-magicians/)

> - [Live Demo on Render](https://math-magicians-ab.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 of you choice.

  - A text editor of your choice.

  - An installed node.js on your local system

### Setup

Clone this repository to your desired folder:

- Use the following Commands:

      cd your-desired-folder

      git clone [email protected]:ab-noori/math-magicians.git

### Install

- Install this project with:

       npx create-react-app my-app

       cd my-app

       npm start

### Usage

- Use following commands to run on your local system:

      npm run build

      npm run deploy

### Run tests

- Run the following script and style test:

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

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

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

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

 

### Deployment

- You can deploy this project using:

      npm run build

      gh-pages -d build

(back to top)


## 👥 Authors 

👤 **Abdul Ali Noori**

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

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

- LinkedIn: [abdul-ali-noori](https://www.linkedin.com/in/abdul-ali-noori-384b85195/)

## 🔭 Future Features 

- [ ] **[Add About page]**

- [ ] **[Add Contact page]**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/ab-noori/math-magicians/issues).

(back to top)


## ⭐️ Show your support 

 

  If you like this project, give it a star.

(back to top)


## 🙏 Acknowledgments 

  I would like to thank Microverse and my coding partners, and a Micronaut, Miss [`Kanza Tahreem`](https://github.com/KanzaTahreem), she has done amazing projects, I inspired from her project for this project. also I want to give credit to [`Nerd's lesson`](https://www.youtube.com/@Nerdslesson)

YouTub Channel, it's [`react tutorial`](https://www.youtube.com/watch?v=cd3P3yXyx30) is really helpfull.

(back to top)


## ❓ FAQ (OPTIONAL) 

- **How to make it mobile friendly?**

  - Put a viewport tag in the header

- **How to design the site?**

  - Draw a mockup before start to code

(back to top)


## 📝 License 

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

(back to top)