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 #3 from karlavdelgadof/development
Casptone M3: Mintok Crypto Market App
- Loading branch information
Showing
55 changed files
with
36,555 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,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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. | ||
|
||
# dependencies | ||
/node_modules | ||
/.pnp | ||
.pnp.js | ||
|
||
# testing | ||
/coverage | ||
|
||
# production | ||
/build | ||
|
||
# misc | ||
.DS_Store | ||
.env.local | ||
.env.development.local | ||
.env.test.local | ||
.env.production.local | ||
|
||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* |
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 |
---|---|---|
@@ -0,0 +1,2 @@ | ||
{ | ||
} |
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,7 @@ | ||
## Copyright 2022, [KARLA DELGADO] | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of this [APP TYPE] and associated documentation files, to deal in the [APP TYPE] without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the [APP TYPE], and to permit persons to whom the [APP TYPE] is furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the [APP TYPE]. | ||
|
||
THE [APP TYPE] IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE [APP TYPE] OR THE USE OR OTHER DEALINGS IN THE [APP TYPE]. |
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,94 @@ | ||
# Capstone-React-M3 | ||
This is a SPA built with React and Redux. The app retrieves data from an API that allow users to get information about the NFT's Market. | ||
![](https://img.shields.io/badge/Microverse-blueviolet) | ||
|
||
![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E) | ||
![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB) | ||
![Redux](https://img.shields.io/badge/redux-%23593d88.svg?style=for-the-badge&logo=redux&logoColor=white) | ||
![Webpack](https://img.shields.io/badge/webpack-%238DD6F9.svg?style=for-the-badge&logo=webpack&logoColor=black) | ||
![Jest](https://img.shields.io/badge/-jest-%23C21325?style=for-the-badge&logo=jest&logoColor=white) | ||
![Netlify](https://img.shields.io/badge/netlify-%23000000.svg?style=for-the-badge&logo=netlify&logoColor=#00C7B7) | ||
|
||
# Mintok Crypto Market App :coin: :bar_chart: | ||
|
||
> Mintok is an SPA app built with React and Redux (Redux ToolKit) that provides market-based information and statistics about cryptocurrency.The application fetches the data about the coins from the [CoinLore API](https://www.coinlore.com/cryptocurrency-data-api) and allows users to check, discover and search (constantly-updated) statistics about the top 100 coins in the market. | ||
|
||
## Built With :hammer_and_wrench: | ||
|
||
- **HTML/CSS & JS best practices:** Correct use of tags, elements, properties and syntax. | ||
- **GitHub flow:** Correct use of Branches for deployment and features development. | ||
- **Linters Check:** Local and Pull Request check for errors, bugs and stylistic errors in code. | ||
- **Webpack:** Bundler form JavaScript files for usage in a browser. | ||
- **Jest:** JS testing framework used for the app testing. | ||
- **REACT JS:** JS library used for the basic structure (components). | ||
- **Redux/Redux Toolkit:** JS library used to handle the app state changes/updates. | ||
- **CoinLore API:** A free cryptocurrency api that provides updated data about more than 9393 coins, 400+ exchanges. . | ||
|
||
## Preview :eye_speech_bubble: | ||
|
||
### Mobile Version :iphone: | ||
|
||
- **Home Page** | ||
|
||
![](ss-mob-1.png) | ||
|
||
- **Details Page** | ||
|
||
![](ss-mob-2.png) | ||
|
||
### Desktop Version :desktop_computer: | ||
|
||
- **Home Page** | ||
|
||
![](ss-desktop-1.png) | ||
|
||
- **Details Page** | ||
|
||
![](ss-desktop-2.png) | ||
|
||
|
||
## Live Demo :arrow_forward: :cd: | ||
|
||
[Mintok Crypto App :coin: :bar_chart:](https://mintok-kd.netlify.app) | ||
|
||
|
||
## Set Up Guide :page_facing_up: | ||
|
||
1. Use the following link for "$ git clone" the [repo](https://github.com/karlavdelgadof/Capstone-React-M3.git) and cd Capstone-React-M3 | ||
|
||
2. "npm install" to install all the dependencies | ||
|
||
3. "npm start" to run the live version locally | ||
|
||
4. "code ." To open the project on your local editor | ||
|
||
5. Please click on the "access link" so you can check the live demo | ||
|
||
6. You can use the Mintok App to check and search coins with their respective statistic/info :bar_chart: :coin: | ||
|
||
## Authors :writing_hand: :busts_in_silhouette: | ||
|
||
:woman_technologist: **Karla Delgado** :writing_hand: | ||
|
||
- GitHub: [@karlavdelgadof](https://github.com/karlavdelgadof) | ||
- Twitter: [@karlavdelgadof](https://twitter.com/karlavdelgadof) | ||
- LinkedIn: [Karla Delgado](https://www.linkedin.com/in/karla-delgado-613a32239/) | ||
|
||
## 🤝 Contributing | ||
|
||
Contributions, issues, and feature requests are welcome! | ||
|
||
Feel free to check the [issues page](../../issues/). | ||
|
||
## Acknowledgments :star2: | ||
|
||
- Original design idea by [Nelson Sakwa](https://www.behance.net/gallery/31579789/Ballhead-App-(Free-PSDs)) on Behance. | ||
- [Coinlore API](https://www.coinlore.com/cryptocurrency-data-api) for app data. | ||
|
||
|
||
## Show your support | ||
|
||
Give a ⭐️ if you like this project! | ||
|
||
## 📝 License | ||
|
||
This project is [MIT](./MIT.md) licensed. |
Oops, something went wrong.