https://github.com/microverse-fullstack-program/math_magicians
https://github.com/microverse-fullstack-program/math_magicians
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/microverse-fullstack-program/math_magicians
- Owner: Microverse-Fullstack-Program
- License: mit
- Created: 2023-01-23T12:06:32.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-21T06:02:40.000Z (almost 3 years ago)
- Last Synced: 2025-01-11T18:41:53.553Z (about 1 year ago)
- Language: JavaScript
- Size: 2.18 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Calculator APP Developed Using React
# 📗 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 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
- HTML5
- CSS3
- JavaScript
- ReactJS
> - VS Editor
> - GitHub and Gitflow
> - JavaScript ES6 Module
> - ReactJS
> - Web Pack
> - Jest Test
> - React Testing Library
> The key features of this website include.
> - **Interactive**
> - **Virtual DOM**
> - **Use JSX**
- [Live Demo Link](https://react-math-magician-p22w.onrender.com/)
> To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need to install npm and node.js as well as webpack and linter modules
### Setup
Clone this repository to your desired folder:
0. Install git if not already installed
1. Use VScode: open terminal in VScode
2. Navigate to the directory where you want clone the copy of this repository
3. Create new directory [optional]
4. Clone the repo using the below command
> git clone https://github.com/Microverse-Fullstack-Program/math_magicians.git
5. Alternatively, you can download the zip file of your project by clicking on the Code button on the right side of your project page and clicking on Download ZIP
## Install and Run
In the project directory, you can run:
### `npm start`
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
The page will reload when you make changes.\
You may also see any lint errors in the console.
### `npm run build`
Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### Usage
This project can be used to learn and practice basics of React.js. Specifically;
* React components.
* React Events.
* Refactor with hooks.
> #### Getting Started with Create React App
> - This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
> The collaborators of this project.
👤 **Chere Lemma**
- GitHub: [@githubhandle](https://github.com/cherelemma)
- Twitter: [@twitterhandle](https://twitter.com/Chere21271613)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/chere-lemma27211613)
- [ ] Allow user to add qoutes
- [ ] Add actual content to Homepage
- [ ] Improve the UI/UX features
- [ ] Add scientific calculator features
- [ ] Store the calculation history
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/Microverse-Fullstack-Program/math_magicians/issues).
Give a ⭐️ if you like this project!
> I would like to thank [Microverseinc](https://github.com/microverseinc) for.
* [Readme-template](https://github.com/microverseinc/readme-template)
* [Linter for React & Redux](https://github.com/microverseinc/linters-config)
This project is [MIT](./LICENSE) licensed.