https://github.com/cancelei/math-magicians2
Main learning points: Use React in a complete application. Done while doing Microverse Coding School.
https://github.com/cancelei/math-magicians2
Last synced: 3 months ago
JSON representation
Main learning points: Use React in a complete application. Done while doing Microverse Coding School.
- Host: GitHub
- URL: https://github.com/cancelei/math-magicians2
- Owner: cancelei
- License: mit
- Created: 2023-07-11T15:05:42.000Z (almost 2 years ago)
- Default Branch: Development
- Last Pushed: 2023-07-22T19:47:42.000Z (almost 2 years ago)
- Last Synced: 2025-01-17T05:10:04.866Z (5 months ago)
- Language: JavaScript
- Homepage: https://calculator-8bmq.onrender.com/
- Size: 1.14 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Math Magician
# 📗 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)
# 📖 React Math Magicians
This is react project that includes a real calculator for basic operations with operants. It will have many branches and clear commit messages.
## 🛠 Built With Love and Passion
Client
- Complete APP with 3 SPA views, without Create React App.
- Routing System using React Route and Improved Styling for all pages/Nav (Hovers);
- Fetch Quotes on the end of the Calculator.
- Functional Components using React
- Improved Layout
- Component that created all the styling.
- React Html/Css/JavaScript best paractice
- Using gitflow and GitHub flow
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
Download Project Files from github.
### Setup
Clone this repository to your desired folder:
### Install
Install Node Package by running:
- npm install
### Usage
- In other to use the repo you either to create a branch to create new features.
- But in order to run the project use the commands below:
- npm run build (It will create a production ready file)
- npm start (It will run the server on your local machine)
### Run Linters (Testing)
I have added Linters different kinds of Linters to help avoid typos and ensure the best practices of the code base.
So while using this repository if you need to check your work no matter if you have worked on HTML or CSS, or even JS you can use the commands below.
- To run the linter test on index.html or any HTML file. Use the below command:
npx hint .
-To run linter test on Stylesheets (CSS or sass). Use the below command:
npx Stylelint "**/*.{css,scss}"
- To run linter test on ES Lint (JS). Use the below command:
npx eslint .
### [Deployment](calculator-8bmq.onrender.com)
👤 **Author Glauber Bannwart**
- GitHub: [@cancelei](https://github.com/cancelei)
- LinkedIn: [LinkedIn](https://linkedin.com/in/gbannwart)
- Implement testing with weekly coding partner (next PR);
Contributions, issues, and feature requests are welcome! Please consider this issue link: [Project Issues](https://github.com/cancelei/Math-magicians2/issues)
If you like this project kindly leave a star!
We are gratefull of Microverse collaborators for creating such an amazing envirnment that we can work and learn.
This project is [MIT](./LICENSE.md) licensed.