-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6 from paulsaenzsucre:release/0.1.0
Change home address.
- Loading branch information
Showing
29 changed files
with
34,147 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
{ | ||
"presets": [ | ||
"@babel/preset-react" | ||
], | ||
"plugins": ["@babel/plugin-syntax-jsx"] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
{ | ||
"env": { | ||
"browser": true, | ||
"es6": true, | ||
"jest": true | ||
}, | ||
"parser": "@babel/eslint-parser", | ||
"parserOptions": { | ||
"ecmaFeatures": { | ||
"jsx": true | ||
}, | ||
"ecmaVersion": 2018, | ||
"sourceType": "module" | ||
}, | ||
"extends": ["airbnb", "plugin:react/recommended", "plugin:react-hooks/recommended"], | ||
"plugins": ["react"], | ||
"rules": { | ||
"react/jsx-filename-extension": ["warn", { "extensions": [".js", ".jsx"] }], | ||
"react/react-in-jsx-scope": "off", | ||
"import/no-unresolved": "off", | ||
"no-shadow": "off" | ||
}, | ||
"ignorePatterns": [ | ||
"dist/", | ||
"build/" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
name: Build and Deploy | ||
on: [push] | ||
permissions: | ||
contents: write | ||
jobs: | ||
build-and-deploy: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v3 | ||
|
||
- name: Install and Build | ||
run: | | ||
npm ci | ||
npm run build | ||
- name: Deploy | ||
uses: JamesIves/github-pages-deploy-action@v4 | ||
with: | ||
folder: build |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
name: Linters | ||
|
||
on: pull_request | ||
|
||
env: | ||
FORCE_COLOR: 1 | ||
|
||
jobs: | ||
eslint: | ||
name: ESLint | ||
runs-on: ubuntu-22.04 | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- uses: actions/setup-node@v1 | ||
with: | ||
node-version: "12.x" | ||
- name: Setup ESLint | ||
run: | | ||
npm install --save-dev eslint@7.x eslint-config-airbnb@18.x eslint-plugin-import@2.x eslint-plugin-jsx-a11y@6.x eslint-plugin-react@7.x eslint-plugin-react-hooks@4.x @babel/eslint-parser@7.x @babel/core@7.x @babel/plugin-syntax-jsx@7.x @babel/preset-env@7.x @babel/preset-react@7.x | ||
[ -f .eslintrc.json ] || wget https://raw.githubusercontent.com/microverseinc/linters-config/master/react-redux/.eslintrc.json | ||
[ -f .babelrc ] || wget https://raw.githubusercontent.com/microverseinc/linters-config/master/react-redux/.babelrc | ||
- name: ESLint Report | ||
run: npx eslint . | ||
stylelint: | ||
name: Stylelint | ||
runs-on: ubuntu-22.04 | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- uses: actions/setup-node@v1 | ||
with: | ||
node-version: "12.x" | ||
- name: Setup Stylelint | ||
run: | | ||
npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x | ||
[ -f .stylelintrc.json ] || wget https://raw.githubusercontent.com/microverseinc/linters-config/master/react-redux/.stylelintrc.json | ||
- name: Stylelint Report | ||
run: npx stylelint "**/*.{css,scss}" | ||
nodechecker: | ||
name: node_modules checker | ||
runs-on: ubuntu-22.04 | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- name: Check node_modules existence | ||
run: | | ||
if [ -d "node_modules/" ]; then echo -e "\e[1;31mThe node_modules/ folder was pushed to the repo. Please remove it from the GitHub repository and try again."; echo -e "\e[1;32mYou can set up a .gitignore file with this folder included on it to prevent this from happening in the future." && exit 1; fi |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
README.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
{ | ||
"extends": ["stylelint-config-standard"], | ||
"plugins": ["stylelint-scss", "stylelint-csstree-validator"], | ||
"rules": { | ||
"at-rule-no-unknown": [ | ||
true, | ||
{ | ||
"ignoreAtRules": ["tailwind", "apply", "variants", "responsive", "screen"] | ||
} | ||
], | ||
"scss/at-rule-no-unknown": [ | ||
true, | ||
{ | ||
"ignoreAtRules": ["tailwind", "apply", "variants", "responsive", "screen"] | ||
} | ||
], | ||
"csstree/validator": true | ||
}, | ||
"ignoreFiles": ["build/**", "dist/**", "**/reset*.css", "**/bootstrap*.css", "**/*.js", "**/*.jsx"] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,202 @@ | ||
# Math-Magicians | ||
This project is a single page app that allows users to make simple calculations. Its coded using React. | ||
<a name="readme-top"></a> | ||
|
||
<div align="center"> | ||
<!-- You are encouraged to replace this logo with your own! Otherwise you can also remove it. --> | ||
<img src="./public/logo512.png" alt="logo" width="140" height="auto" /> | ||
<br/> | ||
|
||
<h3><b>Math Magicians</b></h3> | ||
|
||
</div> | ||
|
||
# 📗 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) | ||
|
||
<!-- PROJECT DESCRIPTION --> | ||
|
||
# 📖 MATH MAGICIANS<a name="about-project"></a> | ||
|
||
**Math Magicians** is a single page app that lets users do simple calculations. | ||
|
||
## 🛠 Built With <a name="built-with"></a> | ||
|
||
### Tech Stack <a name="tech-stack"></a> | ||
|
||
**Math Magicians** is coded with standard languages like HTML5, CSS3, JavaScript; and React as a front-end framework. | ||
|
||
<details> | ||
<summary>Client</summary> | ||
<ul> | ||
<li><a href="https://reactjs.org/">React.js</a></li> | ||
<li><a href="https://html.spec.whatwg.org/multipage/">HTML 5 </a></li> | ||
<li><a href="https://html.spec.whatwg.org/multipage/">CSS 3 </a></li> | ||
<li><a href="https://html.spec.whatwg.org/multipage/">JavaScript </a></li> | ||
</ul> | ||
</details> | ||
|
||
### Key Features <a name="key-features"></a> | ||
|
||
- **You can see a calculator mockup with a display and buttons for digits and operations.** | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
## 🚀 Live Demo <a name="live-demo"></a> | ||
|
||
Click in the following link to see a working live version of this project. | ||
|
||
- [Live Demo Link](https://elafildecolor.github.io/Math-Magicians/) | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
## 💻 Getting Started <a name="getting-started"></a> | ||
|
||
To get a local copy up and running, follow these steps. | ||
|
||
### Prerequisites | ||
|
||
In order to run this project you need to have installed: | ||
|
||
- [ ] You’ll need to have Node >= 14.0.0 and npm >= 5.6 on your machine. | ||
|
||
Optionally, in order to modify this project you should to have installed: | ||
|
||
- [ ] Git. | ||
|
||
- [ ] Code editor like: [Visual Studio code](https://code.visualstudio.com/), [Sublime text](https://www.sublimetext.com/) or others... | ||
|
||
### Setup | ||
|
||
To clone this repository to your desired folder: | ||
|
||
- You can download the **Zip** file from the GitHub repository, or clone the repository with: | ||
|
||
```console | ||
git clone https://github.com/elafildecolor/Math-Magicians.git | ||
``` | ||
|
||
- Access the cloned directory with: | ||
|
||
```console | ||
cd Math-Magicians | ||
``` | ||
|
||
- Open it with your favorite code editor or with the live server | ||
|
||
### Install | ||
|
||
To install run: | ||
|
||
```console | ||
npm install | ||
``` | ||
### Usage | ||
|
||
To run the project, execute the following command in the project directory: | ||
|
||
```console | ||
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. | ||
|
||
### Run tests | ||
|
||
To run tests, run the following command: | ||
|
||
|
||
```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. | ||
|
||
### Build | ||
To build the project, run the following command: | ||
|
||
```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. | ||
|
||
### Deployment <a name="deployment"></a> | ||
|
||
You car read more about deployment in the following link: | ||
|
||
[Deploy a React application](https://facebook.github.io/create-react-app/docs/deployment) | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
## 👥 Authors <a name="authors"></a> | ||
|
||
👤 **Paul Sáenz Sucre** | ||
|
||
- GitHub: [@elafildecolor](https://github.com/elafildecolor) | ||
- Twitter: [@paulsaenzsucre](https://twitter.com/paulsaenzsucre) | ||
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/paulsaenzsucre) | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
## 🔭 Future Features <a name="future-features"></a> | ||
|
||
Will implement these features in the future. | ||
|
||
- [ ] **Home page** | ||
- [ ] **Calculator page** | ||
- [ ] **Quote page** | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
## 🤝 Contributing <a name="contributing"></a> | ||
|
||
Contributions, issues, and feature requests are welcome! | ||
|
||
Feel free to check the [issues page](../../issues/). | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
## ⭐️ Show your support <a name="support"></a> | ||
|
||
Give a ⭐️ if you like this project! | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
## 🙏 Acknowledgments <a name="acknowledgements"></a> | ||
|
||
- Hat tip to anyone whose code was used. | ||
- Thanks for all the curated content that was provided to us. | ||
- Thanks to my learning and coding partners for all their support. | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
## 📝 License <a name="license"></a> | ||
|
||
This project is [MIT](./LICENSE) licensed. | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> |
Oops, something went wrong.