-
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 #32 from nilab-khwaja/dev
React & Redux group project - Space Travelers' Hub
- Loading branch information
Showing
39 changed files
with
20,742 additions
and
1 deletion.
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 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 "**/*.{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 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@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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2023 Nilab Khwajazada | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software 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 Software. | ||
|
||
THE SOFTWARE 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 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
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,151 @@ | ||
# space-travelers-hub | ||
<a name="readme-top"></a> | ||
|
||
<div align="center"> | ||
<h3><b>Space Travlers' Hub</b></h3> | ||
</div> | ||
|
||
# 📗 Table of Contents | ||
|
||
- [📗 Table of Contents](#-table-of-contents) | ||
- [📖 Space-Travlers-Hub](#-space_travler_hub) | ||
- [🛠 Built With ](#-built-with-) | ||
- [Tech Stack ](#tech-stack-) | ||
- [Key Features ](#key-features-) | ||
- [💻 Getting Started ](#-getting-started-) | ||
- [Prerequisites](#prerequisites) | ||
- [Setup](#setup) | ||
- [Usage](#usage) | ||
- [Run tests](#run-tests) | ||
- [👥 Author(s) ](#-authors-) | ||
- [🔭 Future Features ](#-future-features-) | ||
- [🤝 Contributing ](#-contributing-) | ||
- [⭐️ Show your support ](#️-show-your-support-) | ||
- [🙏 Acknowledgments ](#-acknowledgments-) | ||
- [📝 License ](#-license-) | ||
|
||
# 📖 Space Travelers' Hub<a name="about-project"></a> | ||
|
||
Space Travelors' Hub is an application that allows users to see data from API, reserve rocket, cancel reservation, join mission, leave mission and see the profile. | ||
|
||
## 🛠 Built With <a name="built-with"></a> | ||
|
||
### Tech Stack <a name="tech-stack"></a> | ||
|
||
- Reactjs | ||
- CSS | ||
- Redux | ||
- BootStrap | ||
|
||
### Key Features <a name="key-features"></a> | ||
|
||
- [ ] **Reserve Rocket** | ||
- [ ] **Cancel Reservation** | ||
- [ ] **Join Mission** | ||
- [ ] **Leave Mission** | ||
|
||
<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: | ||
|
||
- a browser | ||
- git | ||
- nodejs | ||
|
||
### Setup | ||
|
||
Clone this repository to your desired folder: | ||
|
||
```sh | ||
cd my-folder | ||
git clone https://github.com/nilab-khwaja/space-travelers-hub.git | ||
npm install | ||
``` | ||
|
||
### Usage | ||
|
||
To run the project, execute the following command: | ||
|
||
```sh | ||
npm run start | ||
``` | ||
|
||
### Run tests | ||
|
||
To run tests, run the following commands: | ||
|
||
```sh | ||
npm run stylelint | ||
npx hint . | ||
npm run eslint . | ||
npm run test | ||
``` | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
### Deployment | ||
|
||
- I used Render to deploy my website | ||
- For more information about publishing sources, see "[About render](https://render.com/docs)" | ||
|
||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
<!-- AUTHORS --> | ||
|
||
## 👥 Authors <a name="authors"></a> | ||
|
||
> | ||
👤 **Author1** | ||
|
||
- GitHub: [@nilab-khwaja](https://github.com/nilab-khwaja) | ||
- Twitter: [@nilab](https://x.com/NilabKhwajazada?t=hEkqy2CCNFOIfGtbmD2gLA&s=35) | ||
- LinkedIn: [@nilab-khwajazada](https://www.linkedin.com/in/nilab-khwajazada) | ||
|
||
👤 **Author2** | ||
|
||
- GitHub: [evansnyamekye](https://github.com/evansnyamekye) | ||
- Twitter: [@nyamekye2131](https://twitter.com/nyamekye2131) | ||
- LinkedIn: [Evans Kofi Nyamekye](https://www.linkedin.com/in/evans-kofi-nyamekye-1980a4117/) | ||
|
||
|
||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
## 🔭 Future Features <a name="future-features"></a> | ||
|
||
- [ ] **Add a Dragon tab** | ||
|
||
<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](https://github.com/nilab-khwaja/space-traveler-hub/issues). | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
## ⭐️ Show your support <a name="support"></a> | ||
|
||
If you like this project give me a follow and/or a star | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
## 🙏 Acknowledgments <a name="acknowledgements"></a> | ||
|
||
We would like to thank all my coding partners at Microverse | ||
|
||
<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.