Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/onjoseph/mathmagicians
"Math magicians" 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.
https://github.com/onjoseph/mathmagicians
es6 javascript microverse-projects react-router reactjs spa
Last synced: 7 days ago
JSON representation
"Math magicians" 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.
- Host: GitHub
- URL: https://github.com/onjoseph/mathmagicians
- Owner: ONJoseph
- License: mit
- Created: 2023-01-09T22:15:55.000Z (about 2 years ago)
- Default Branch: development
- Last Pushed: 2023-01-19T23:34:12.000Z (about 2 years ago)
- Last Synced: 2024-12-09T16:41:25.996Z (2 months ago)
- Topics: es6, javascript, microverse-projects, react-router, reactjs, spa
- Language: JavaScript
- Homepage: https://github.com/ONJoseph/mathmagicians
- Size: 1.96 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Microverse README Template
# 📗 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)
- [📝 License](#license)
**[Math Magicians]** is a website for all fans of mathematics. It is a Single Page App (SPA) that allows users to make simple calculations and Read a random math-related quote.
Client/Server
- HTML/CSS & JavaScript best practices: Correct use of tags, elements, properties and syntax.
- Linters Check: Local and Pull Request check for errors, bugs and stylistic errors in code.
- Gitflow
- **[Home Page]**
- **[Calculator Page]**
- **[Quotes Page]**
- [Live Demo Link](No deployment yet)
To get a local copy up and running, follow these steps:
### Prerequisites
In order to run this project you need:
- Internet connection and browser
- A source code editor(preferably Visual Studio Code)
- Browser
- Install nodeJS along with NPM
### Setup
Clone this repository to your desired folder:
-Local environment with `git clone https://github.com/ONJoseph/mathmagicians.git`
- This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
### Install
Install this project with:
- [Git](https://git-scm.com/downloads)
- [Node](https://nodejs.org/en/download/)
- Run `npm i` on the root of the project and you're good to go. All of the necessary packages will be installed for you!
### Usage
To run the project, execute the following command:
- Clone the repository using `git clone https://github.com/ONJoseph/mathmagicians.git`
- Change directory into the project folder: `cd mathmagicians`
- Run `npm install`
- Run `npm start`
- A new browser will open automatically with application loaded
## Available Scripts
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 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.
### `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.
### `npm run eject`
**Note: this is a one-way operation. Once you `eject`, you can't go back!**
If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
### Deployment
You can deploy this project using:
- Run `npm run build` for Webpack to generate the dist files corresponding to your actual /src file
- GitHub: [@ONJoseph](https://github.com/ONJoseph)
- Twitter: [@ONJoseph1](https://twitter.com/ONJoseph1)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/o-n-joseph-ba8425147/)
- [ ] **[Project 2: Components]**
- [ ] **[Project 3: Events]**
- [ ] **[Project 4: Refactor with hooks]**
- [ ] **[Project 5: Full website.]**
- [ ] **[Project 6: Tests (pair programming)]**
- [ ] **[Exercise: Deploy]**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/ONJoseph/mathmagicians/issues).
If you like this project please give a ⭐️ to show your support!
I would like to thank:
- [Microverse](https://www.microverse.org/)
- Code Reviewers
- Coding Partners
This project is [MIT](https://github.com/ONJoseph/mathmagicians/blob/development/LICENCE) licensed.