Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/tanveerisonline/math_magicians

This project is a React Single Page App. In this project you can find calculator to perform calculation. This project is using Big.js library to calculate calculation with minimal code. This project is using React Router. This project is using best practices with React and JavaScript.
https://github.com/tanveerisonline/math_magicians

gitflow javascript jsx react

Last synced: about 20 hours ago
JSON representation

Host: GitHub
URL: https://github.com/tanveerisonline/math_magicians
Owner: tanveerisonline
License: mit
Created: 2023-01-11T10:41:42.000Z (about 2 years ago)
Default Branch: dev
Last Pushed: 2023-01-18T17:14:04.000Z (about 2 years ago)
Last Synced: 2024-05-17T15:36:22.959Z (8 months ago)
Topics: gitflow, javascript, jsx, react
Language: JavaScript
Homepage:
Size: 638 KB
Stars: 3
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE.txt

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)

- [💻 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](#faq)

- [📝 License](#license)

# 📖 [MATH MAGICIAN] 

> Math Magicians can compute all basic math operations. I used hooks to handle state. Invalid operation errors are successfully handled through useEffect.

## 🛠 Built With 

### Tech Stack 

> Following technologies have been used in this project.

  Client

  


    React JS

    JSX

    CSS

    JavaScript5

    Webpack Framework

  


  Server

  


    Github Pages

  


### Key Features 

> This project is a React Single Page App.

> In this project you can find calculator to perform calculation.

> This project is using Big.js library to calculate calculation with minimal code.

> This project is using React Router.

> This project is using best practices with React and JavaScript.

> This project follows the gitflow convention.

> This is using eslint and stylelint to check errors.

(back to top)


## 🚀 Live Demo 

> Click to visit 

(back to top)


## 💻 Getting Started 

> This is how a new developer could make use this project.

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

### Prerequisites

In order to run this project you need:

- [ ] A PC or Mac.

- [ ] An active internet connection.

- [ ] Some knowledge of git and github.

### Setup

Clone this repository by using the command line : git clone https://github.com/tanveerisonline/Math_Magicians.git

### Install

Install this project with:

Use npm install after cloning this project

### Usage

- [ ] First you need to download this repo or clone this repo.

- [ ] Open this project in your local machine.

- [ ] Open Terminal in your machine.

- [ ] run npm install in your terninal to install necessary required dependencies for this project.

- [ ] Copy index.html file path and paste it in your browser url.

- [ ] now the project will be running.

### Deployment

You can deploy this project using:

Github Pages.

(back to top)


## 👥 Authors 

> Mention all of the collaborators of this project.

👤 **Author1**

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

(back to top)


## 🔭 Future Features 

> Following are a few features i will add to the project in future.

- [ ] I will add a database to this project in future where i can save user data.

- [ ] I will add more functionality to this project like searching, deleting etc.

- [ ] I will update the interface and design of the project in future.

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)


## ⭐️ Show your support 

If you're committed to making the world a better place, please support our project.

(back to top)


## 🙏 Acknowledgments 

I would like to give credit to the following people who have inspired my codebase:

- [ ] The Whole Microverse Team - thank you so much for this great learning platform.

(back to top)


## ❓ FAQ 

- **[Question_1]** What technologies i have used in this project ?

  - [Answer_1]:Thanks for the question you can find the answer at the top section of this readme.md file where i have explained everything.

- **[Question_2]** Have you used webpack in this project ?

  - [Answer_2] Yes i have used webpack 5 in this project.

(back to top)


## 📝 License 

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

\_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish.

(back to top)