├── .gitignore
├── LICENSE
├── README.md
├── package-lock.json
├── package.json
├── public
├── favicon.ico
├── index.html
├── logo192.png
├── logo512.png
├── manifest.json
└── robots.txt
└── src
├── App.css
├── App.js
├── assets
└── project-image.jpg
├── index.css
├── index.js
└── store
├── store.js
└── users
├── UsersList.js
└── usersSlice.js
/.gitignore:
--------------------------------------------------------------------------------
1 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2 |
3 | # dependencies
4 | /node_modules
5 | /.pnp
6 | .pnp.js
7 |
8 | # testing
9 | /coverage
10 |
11 | # production
12 | /build
13 |
14 | # misc
15 | .DS_Store
16 | .env.local
17 | .env.development.local
18 | .env.test.local
19 | .env.production.local
20 |
21 | npm-debug.log*
22 | yarn-debug.log*
23 | yarn-error.log*
24 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2023 Abdul Ali Noori
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | 
4 |
5 |
90 |
91 |
92 |
93 | ## 💻 Getting Started
94 |
95 | To get a local copy up and running, follow these steps:
96 |
97 | ### Prerequisites
98 |
99 | In order to run this project you need:
100 | - A browser of you choice.
101 | - A text editor of your choice.
102 | - An installed node.js on your local system
103 |
104 | ### Setup
105 |
106 | Clone this repository to your desired folder:
107 |
108 | - Use the following Commands:
109 |
110 | cd your-desired-folder
111 | git clone git@github.com:ab-noori/template.git
112 |
113 |
114 | ### Install
115 | - Install this project with:
116 |
117 | npx create-react-app my-app
118 | cd my-app
119 | npm start
120 |
121 |
122 | ### Usage
123 | - Use following commands to run on your local system:
124 |
125 | npm run build
126 | npm run deploy
127 |
128 | ### Run tests
129 | - Run the following script and style test:
130 |
131 | npx eslint "**/*.{js,jsx}"
132 | npx eslint "**/*.{js,jsx}" --fix
133 |
134 | npx stylelint "**/*.{css,scss}"
135 | npx stylelint "**/*.{css,scss}" --fix
136 |
137 | ### Deployment
138 | - 1- install `'gh-pages'` with following command:
139 |
140 | npm i -D gh-pages
141 |
142 | - 2- Add `'homepage'` to project's jason file:
143 |
144 | "homepage": "https://ab-noori.github.io/repo-name",
145 |
146 | - 3- Add the following scripts to project's jason file:
147 |
148 | "predeploy": "npm run build",
149 | "deploy": "gh-pages -d build "
150 |
151 | - 4- Finally run the following command:
152 |
153 | npm run deploy
154 |
155 |
156 |
189 |
190 |
191 | ## 🙏 Acknowledgments
192 |
193 | I would like to thank Microverse and my coding partners. Also I want to give credit to [`Nerd's lesson`](https://www.youtube.com/@Nerdslesson)
194 | YouTub Channel, it's [`react tutorial`](https://www.youtube.com/watch?v=cd3P3yXyx30) is really helpfull.
195 |
196 |
197 |
198 |
199 | ## ❓ FAQ (OPTIONAL)
200 |
201 | - **How to make it mobile friendly?**
202 |
203 | - Put a viewport tag in the header
204 |
205 | - **How to design the site?**
206 |
207 | - Draw a mockup before start to code
208 |
209 |