Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Premstats: complete project #1

Merged
merged 34 commits into from
Feb 10, 2022
Merged
Show file tree
Hide file tree
Changes from 32 commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
0853ed4
Add base styles
anuarshaidenov Feb 7, 2022
4f83034
Import images
anuarshaidenov Feb 7, 2022
6f26fe4
Add and style desktop header
anuarshaidenov Feb 7, 2022
1f37172
Add teams route
anuarshaidenov Feb 7, 2022
e230fe4
Configure redux
anuarshaidenov Feb 7, 2022
44b2f8b
Fetch teams from API
anuarshaidenov Feb 7, 2022
67d122b
Add and style teams section
anuarshaidenov Feb 7, 2022
7446209
Add background image
anuarshaidenov Feb 7, 2022
fcead6c
Add filtered search
anuarshaidenov Feb 7, 2022
8c4c6f3
Add filtered search
anuarshaidenov Feb 8, 2022
fe31a78
Display team form
anuarshaidenov Feb 8, 2022
819fd37
Display match stats
anuarshaidenov Feb 8, 2022
c0ac4e6
Remove image from hero section
anuarshaidenov Feb 8, 2022
ed0f300
Display team league
anuarshaidenov Feb 8, 2022
3a43ea6
Add go back button
anuarshaidenov Feb 8, 2022
987448c
Display team goals
anuarshaidenov Feb 8, 2022
8aeb928
Mock standings
anuarshaidenov Feb 8, 2022
df40658
Display team standings
anuarshaidenov Feb 8, 2022
5678a0b
Add standings page
anuarshaidenov Feb 8, 2022
6bac2b6
Fix eslint errors
anuarshaidenov Feb 9, 2022
10d3ff0
Fix stylelint errors
anuarshaidenov Feb 9, 2022
339621b
Add standings test
anuarshaidenov Feb 9, 2022
1eee673
Add team reducer tests
anuarshaidenov Feb 9, 2022
73c7f6b
Add teams reducer tests
anuarshaidenov Feb 9, 2022
ee984c3
Add hero section test
anuarshaidenov Feb 9, 2022
5ad933b
Add teams section test
anuarshaidenov Feb 9, 2022
0b107f3
Add tests for standings component
anuarshaidenov Feb 9, 2022
83804ff
Change endpoint
anuarshaidenov Feb 9, 2022
4d2d195
Change key
anuarshaidenov Feb 9, 2022
045952e
Hide api key
anuarshaidenov Feb 10, 2022
f2e00fb
Update README.md
anuarshaidenov Feb 10, 2022
49c2928
Update README.md
anuarshaidenov Feb 10, 2022
db248ae
Add video presentation link
anuarshaidenov Feb 10, 2022
d3251cc
Add acknowledgements section
anuarshaidenov Feb 10, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions .babelrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"presets": ["@babel/preset-react"],
"plugins": ["@babel/plugin-syntax-jsx"]
}
24 changes: 24 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"env": {
"browser": true,
"es6": true,
"jest": true
},
"parser": "@babel/eslint-parser",
"parserOptions": {
"ecmaFeatures": {
"jsx": true
},
"ecmaVersion": 2018,
"sourceType": "module"
},
"extends": ["airbnb", "plugin:react/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/"]
}
37 changes: 37 additions & 0 deletions .github/workflows/linters.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Linters

on: pull_request

env:
FORCE_COLOR: 1

jobs:
eslint:
name: ESLint
runs-on: ubuntu-18.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-18.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"
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# API keys
.env

# dependencies
/node_modules
/.pnp
Expand Down
17 changes: 17 additions & 0 deletions .stylelintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"extends": ["stylelint-config-standard"],
"plugins": ["stylelint-scss", "stylelint-csstree-validator"],
"rules": {
"at-rule-no-unknown": null,
"scss/at-rule-no-unknown": true,
"csstree/validator": true
},
"ignoreFiles": [
"build/**",
"dist/**",
"**/reset*.css",
"**/bootstrap*.css",
"**/*.js",
"**/*.jsx"
]
}
88 changes: 49 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,80 @@
# Getting Started with Create React App
![](https://img.shields.io/badge/Microverse-blueviolet)

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
# Premstats

## Available Scripts
> This is a web app that displays current stats of your favorite Premier League team.

In the project directory, you can run:
<div>
<img alt="main screenshot" src='./screenshot-1.png' width=90%/>
</div>
<div>
<img alt="my profile page" src='./screenshot-2.png' width=90%/>
</div>
<div>
<img alt="my profile page" src='./screenshot-3.png' width=90%/>
</div>

### `npm start`
## Built With

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
- ReactJS

The page will reload when you make changes.\
You may also see any lint errors in the console.
## Technologies used

### `npm test`
- Redux
- React Router
- Sass
- React Testing Library

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.
## Live Demo

### `npm run build`
> Warning! The API has limit of 100 requests per day!

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
[Live Demo Link (Netlify)](https://premstats.netlify.app/)
[Live Demo Link (Heroku)](https://premstats.herokuapp.com/)

Comment on lines +36 to 38
Copy link

@Rustamxon7 Rustamxon7 Feb 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You made great efforts to make this project. However, there are a few issues that you need to fix.

  • Adding a LiveDemo link is perfect but you also need to display your Presentation Video 馃帴 link in your Readme.MD file. Please kindly add the LiveDemo link as well 馃敆
  • Another thing in your readme is Acknowledgements. Please also add this and give appropriate credit to the designer of the project, ok 馃憤

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
## Getting Started

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
To get a local copy up and running follow these simple example steps.

### `npm run eject`
### Prerequisites

**Note: this is a one-way operation. Once you `eject`, you can't go back!**
To run the project on your local machine you need to have:

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.
- bash cli.
- npm.

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.
### Setup

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.
Go to the terminal and type:

## Learn More
- `git clone https://github.com/anuarshaidenov/premstats.git [YOUR_PROJECT_NAME]`
- `cd [YOUR_PROJECT_NAME]`
- `npm install`

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
### Usage

To learn React, check out the [React documentation](https://reactjs.org/).
To start a local server on port 3000 run:

### Code Splitting
- `npm start`

This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
## Author

### Analyzing the Bundle Size
馃懁 **Anuar Shaidenov**

This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
- GitHub: [@anuarshaidenov](https://github.com/anuarshaidenov)
- Twitter: [@anuarnyi](https://twitter.com/anuarnyi)
- LinkedIn: [anuarshaidenov](https://linkedin.com/in/anuarshaidenov)

### Making a Progressive Web App
## 馃 Contributing

This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
Contributions, issues, and feature requests are welcome!

### Advanced Configuration
Feel free to check the [issues page](../../issues/).

This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
## Show your support

### Deployment
Give a 猸愶笍 if you like this project!

This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
## 馃摑 License

### `npm run build` fails to minify

This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
This project is [MIT](./MIT.md) licensed.