Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/johnftitor/math_magicians
Math Magicians! This is a website for all fans of mathematics. It is a Single Page App (SPA) that allows users to make basic calculations and read a random math-related quote.
https://github.com/johnftitor/math_magicians
css javascript react
Last synced: about 2 months ago
JSON representation
Math Magicians! This is a website for all fans of mathematics. It is a Single Page App (SPA) that allows users to make basic calculations and read a random math-related quote.
- Host: GitHub
- URL: https://github.com/johnftitor/math_magicians
- Owner: JohnFTitor
- Created: 2022-02-07T16:57:16.000Z (almost 3 years ago)
- Default Branch: dev
- Last Pushed: 2022-03-04T22:02:21.000Z (almost 3 years ago)
- Last Synced: 2023-03-05T12:31:53.055Z (almost 2 years ago)
- Topics: css, javascript, react
- Language: JavaScript
- Homepage: https://jfmath-magicians.netlify.app/
- Size: 4.92 MB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Math Magicians
> Math Magicians is the first React Project I'm building. The main objective of this is to understand React features with a project-based learning approach. This is using them directly
Math Magicians! This is a website for all fans of mathematics. It is a Single Page App (SPA) that allows users to make basic calculations and read a random math-related quote.
## Built With
- HTML/CSS and JavaScript
- React Framework
- Visual Studio Code
## Live Demo
[Heroku Live Demo Link](https://jfmath-magicians.herokuapp.com/)
[Netlify Live Demo Link](https://jfmath-magicians.netlify.app/)
## Getting Started
To get a local copy up and running follow these simple example steps.
- Clone this repository with git clone```https://github.com/JohnFTitor/math_magicians.git``` using your terminal or command line.
- Change to the project directory by entering :
```cd math_magicians``` in the terminal
### Prerequisites
You need to make sure to have installed the latest version of Node.js and npm on your computer.
### Setup
You can clone this repository or simply download the files as a .zip
If you want to set up a personal repository based on this one, you can as well fork it.
### Install
After clone it and before working on it, you have to run ```npm install``` so that all the dependencies of the project get downloaded in your pc locally.
Such dependencies include React app and linters checks, for which you have to install the files following the ```wget``` commands inside linters.yml file.
### Usage
You're free to use this project however you like it for educational purposes. Just keep in mind the acknowledgment described below
To work on the project, run ```npm start``` in your terminal to deploy a live version of the development. This works in watch mode so it automatically reloads any need change you make to the files.
### Run linters checks
Linter Checks are automatically run with Github actions when there's a pull request. If you want to run them locally, remember to have the config file in the root of the local project.
### Deployment
The deployment can be found in through any of the links provided above
## Authors
👤 **Andrés Felipe Arroyave Naranjo**
- GitHub: [@JohnFTitor](https://github.com/JohnFTitor)
- Twitter: [@johnftitor](https://twitter.com/johnftitor)
- LinkedIn: [Andres](https://www.linkedin.com/in/andresarroyavenaranjo/?locale=en_US)
## Acknowledgments
Here's a [link](https://github.com/arcanemutterings/random-quote-generator-api) to the API GitHub Repo from which I got the data for the quotes. Special thanks to the author!
## Show your support
Give a ⭐️ if you like this project!
## 📝 License
This project is [MIT](./MIT.md) licensed.