-
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 #1 from musangamfure/project-development
Add all project files
- Loading branch information
Showing
35 changed files
with
22,547 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,35 @@ | ||
{ | ||
"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" | ||
}, | ||
"overrides": [ | ||
{ | ||
// feel free to replace with your preferred file pattern - eg. 'src/**/*Slice.js' or 'redux/**/*Slice.js' | ||
"files": ["src/**/*Slice.js"], | ||
// avoid state param assignment | ||
"rules": { "no-param-reassign": ["error", { "props": false }] } | ||
} | ||
], | ||
"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@v3 | ||
- uses: actions/setup-node@v3 | ||
with: | ||
node-version: "18.x" | ||
- name: Setup ESLint | ||
run: | | ||
npm install --save-dev [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] @babel/[email protected] @babel/[email protected] @babel/[email protected] @babel/[email protected] @babel/[email protected] | ||
[ -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 "**/*.{js,jsx}" | ||
stylelint: | ||
name: Stylelint | ||
runs-on: ubuntu-22.04 | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- uses: actions/setup-node@v3 | ||
with: | ||
node-version: "18.x" | ||
- name: Setup Stylelint | ||
run: | | ||
npm install --save-dev [email protected] [email protected] [email protected] [email protected] | ||
[ -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@v3 | ||
- 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
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 +1,212 @@ | ||
# react-capstone-project | ||
<a name="readme-top"></a> | ||
|
||
<div align="center"> | ||
|
||
<h3><b> React capstone Project </b></h3> | ||
|
||
</div> | ||
|
||
<!-- TABLE OF CONTENTS --> | ||
|
||
# 📗 Table of Contents | ||
|
||
- [📖 About the Project](#about-project) | ||
- [🛠 Built With](#built-with) | ||
- [Tech Stack](#tech-stack) | ||
- [Key Features](#key-features) | ||
- [💻 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) | ||
|
||
<!-- PROJECT DESCRIPTION --> | ||
|
||
# 📖 TVDB - React capstone <a name="about-project"></a> | ||
|
||
This is a** Movie App **for Microverse REACT-REDUX capstone project. The app will work as database for tv shows where all the shows are retrieved from an API. You can also explore details of each show and filter them via their genres. | ||
|
||
## 🛠 Built With <a name="built-with">HTML5 , CSS, REACT and REDUX</a> | ||
|
||
### Tech Stack <a name="tech-stack"></a> | ||
|
||
<details> | ||
<summary>Client</summary> | ||
<ul> | ||
<li><a href="#">HTML5</a></li> | ||
<li><a href="#">CSS3</a></li> | ||
<li><a href="#">REACT</a></li> | ||
<li><a href="#">REDUX</a></li> | ||
</ul> | ||
</details> | ||
|
||
<!-- Features --> | ||
|
||
### Key Features <a name="key-features"></a> | ||
|
||
- **Responsive design** | ||
- **TV Shows database App** | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
<!-- GETTING STARTED --> | ||
|
||
## 💻 Getting Started <a name="getting-started"></a> | ||
|
||
This could be used as a template for any database or to view TVshows. | ||
|
||
### Prerequisites | ||
|
||
In order to run this project you need: | ||
|
||
- A working Laptop | ||
- A code Editor | ||
- A browser | ||
<!-- | ||
Example command: | ||
```sh | ||
gem install rails | ||
``` | ||
--> | ||
|
||
### Setup | ||
|
||
Clone this repository to your desired folder: | ||
|
||
To clone this repository on your machine run `https://github.com/musangamfure/react-capstone-project.git` | ||
|
||
<!-- | ||
Example commands: | ||
```sh | ||
cd my-folder | ||
git clone [email protected]:myaccount/my-project.git | ||
``` | ||
---> | ||
|
||
### Install | ||
|
||
Install this project with: | ||
|
||
- Run `npm install` | ||
<!-- | ||
Example command: | ||
```sh | ||
cd my-project | ||
gem install | ||
``` | ||
---> | ||
|
||
### Usage | ||
|
||
To run the project, execute the following command: | ||
|
||
- Use `npm start` in terminal | ||
|
||
<!-- | ||
Example command: | ||
```sh | ||
rails server | ||
``` | ||
---> | ||
|
||
### Run tests | ||
|
||
To run tests, run the following command: | ||
|
||
- `npx eslint "**/*.{js,jsx}"` | ||
- `npx stylelint "**/*.{css,scss}"` | ||
|
||
<!-- | ||
Example command: | ||
```sh | ||
bin/rails test test/models/article_test.rb | ||
``` | ||
---> | ||
|
||
### Deployment | ||
|
||
- <a href="https://64a0020c13d46c1dbd548758--reactcapstoneapp.netlify.app/">Click Here for live demo </a> | ||
|
||
## 🚀 Zoom Video (explanation) <a name="zoom"></a> | ||
|
||
- <a href="https://drive.google.com/file/d/1ZSppstvKOjiTamt8t7rPgrlQ0xhmzwv-/view?usp=sharing">Click here for Demo Video</a> | ||
|
||
<!-- | ||
Example: | ||
```sh | ||
``` | ||
--> | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
<!-- AUTHORS --> | ||
|
||
## 👥 Authors <a name="authors"></a> | ||
|
||
👤 **Musangamfura Emmanuel** | ||
|
||
- [GitHub](https://github.com/musangamfure) | ||
- [Twitter](https://twitter.com/musangamfure) | ||
- [LinkedIn](https://www.linkedin.com/in/musangamfurae) | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
<!-- FUTURE FEATURES --> | ||
|
||
## 🔭 Future Features <a name="future-features"></a> | ||
|
||
- Adding Extra Details of each tv show. No of seasons and episodes etc | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
<!-- CONTRIBUTING --> | ||
|
||
## 🤝 Contributing <a name="contributing"></a> | ||
|
||
Contributions, issues, and feature requests are welcome! | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
<!-- SUPPORT --> | ||
|
||
## ⭐️ Show your support <a name="support"></a> | ||
|
||
If you like this project give it a rating. | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
<!-- ACKNOWLEDGEMENTS --> | ||
|
||
## 🙏 Acknowledgments <a name="acknowledgements"></a> | ||
|
||
- I would like to thank [Microverse](https://www.microverse.org/) for providing the resources and the knowledge to work on projects like this. | ||
- credit: credit to [Nelson Sakwa](https://www.behance.net/sakwadesignstudio) the author of the [original design](https://www.behance.net/gallery/31579789/Ballhead-App-(Free-PSDs)) | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
<!-- LICENSE --> | ||
|
||
## 📝 License <a name="license"></a> | ||
|
||
- This project is [MIT](./LICENSE) licensed. | ||
- This project is [creativecommons](https://creativecommons.org/licenses/by-nc/4.0/) licensed. | ||
<a href='https://pngtree.com/free-backgrounds'>free background photos from pngtree.com/</a> | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> |
Oops, something went wrong.