Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maximoortelli/math-magicians
https://github.com/maximoortelli/math-magicians
Last synced: 20 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/maximoortelli/math-magicians
- Owner: maximoortelli
- License: mit
- Created: 2023-09-18T19:26:41.000Z (about 1 year ago)
- Default Branch: dev
- Last Pushed: 2023-09-20T20:49:06.000Z (about 1 year ago)
- Last Synced: 2023-09-21T08:37:19.612Z (about 1 year ago)
- Language: JavaScript
- Size: 817 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Math 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)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
---
**Math Magicians** is a project that allows me to showcase my web development skills and expertise in React and UI/UX design. With a focus on engaging interfaces, I demonstrate proficiency in various aspects including wireframing, component creation, event handling, and API integration. The project embodies intuitive design principles and seamless functionality, delivering a captivating user experience.
It is a Single Page App (SPA) that allows users to:
- Make simple calculations.
- Read a random math-related quote.
---
#### Learning objectives
- Use React components.
- Use React props.
- Use React state.
- Use React routes.
---
---
- **SPA website**
- **React configuration**
- **HTML Generation**
- **CSS Styling**
- **Development Server**
- **Code Quality**
- **Modular Structure**
- **JavaScript Functionality**
- **Gitflow**
- Click Here to see the live demo
> To get a local copy up and running, follow these steps.
> This project requires Node.js and npm installed on your machine.
### Prerequisites
In order to run this project you need:
### Setup
Clone this repository to your desired folder:
Example commands:
```bash
cd math-magiciansa
git clone https://github.com/maximoortelli/Math-magicians.git
```
### Install
Install this project's dependencies with:
- npm install
### Usage
To run the project, execute the following command:
```bash
npm run 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.
### Run tests
```bash
npm test
```
Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
---
👤 **Author1**
- GitHub: [@maximoortelli](https://github.com/maximoortelli)
- LinkedIn: [Maximo Ortelli](https://www.linkedin.com/in/maximo-ortelli-rueda-265228203/)
---
- [ ] **Improve Calculator style**
---
Contributions, issues, and feature requests are welcome!
---
Give a ⭐ if you liked this project!
---
I thank Microverse for this fantastic opportunity.
---
This project is [MIT](./LICENSE) licensed.
---