├── .dockerignore
├── .editorconfig
├── .gitignore
├── .gitmodules
├── VERSIONING.md
├── dep
└── README.md
├── doc
└── README.md
├── res
└── README.md
├── .config
└── README.md
├── .gitattributes
├── .github
├── SUPPORT.md
├── CONTRIBUTING.md
├── SECURITY.md
├── CODE_OF_CONDUCT.md
├── ISSUE_TEMPLATE
│ ├── README.md
│ ├── question.md
│ ├── feature_request.md
│ └── bug_report.md
└── PULL_REQUEST_TEMPLATE
│ ├── README.md
│ └── PULL_REQUEST_TEMPLATE.md
├── samples
└── README.md
├── test
└── README.md
├── tools
└── README.md
├── src
└── README.md
├── README.md
└── LICENSE
/.dockerignore:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/.editorconfig:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/.gitmodules:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/VERSIONING.md:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/dep/README.md:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/doc/README.md:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/res/README.md:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/.config/README.md:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/.gitattributes:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/.github/SUPPORT.md:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/samples/README.md:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/test/README.md:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/tools/README.md:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/.github/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/.github/SECURITY.md:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/src/README.md:
--------------------------------------------------------------------------------
1 |
2 |
--------------------------------------------------------------------------------
/.github/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/README.md:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/.github/PULL_REQUEST_TEMPLATE/README.md:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/question.md:
--------------------------------------------------------------------------------
1 | ---
2 | name: Question
3 | about: Create a question to help us improve our knowledgebase and documentation
4 | labels: question
5 | ---
6 |
7 | # Question
8 |
9 | **Describe your environment.**
10 |
11 | Describe any aspect of your environment relevant to the question.
12 |
13 | **What are you trying to achieve?**
14 |
15 | What did you expect to see?
16 |
17 | ## Additional Context
18 |
19 | Add any other context about the problem here. If you followed an existing
20 | documentation, please share the link to it.
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/feature_request.md:
--------------------------------------------------------------------------------
1 | ---
2 | name: Feature Request
3 | about: Suggest an idea for this project
4 | labels: enhancement
5 | ---
6 |
7 | # Feature Request
8 |
9 |
10 | **Is your feature request related to a problem?**
11 |
12 | If so, provide a concise description of the problem.
13 |
14 | **Describe the solution you'd like:**
15 |
16 | What do you want to happen instead? What is the expected behavior?
17 |
18 | **Describe alternatives you've considered.**
19 |
20 | Which alternative solutions or features have you considered?
21 |
22 | ## Additional Context
23 |
24 | Add any other context about the feature request here.
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/bug_report.md:
--------------------------------------------------------------------------------
1 | ---
2 | name: Bug Report
3 | about: Create a report to help us improve
4 | labels: bug
5 | ---
6 |
7 | # Bug Report
8 |
9 |
10 | ## Symptom
11 |
12 | A clear and concise description of what the bug is.
13 |
14 | **What is the expected behavior?**
15 |
16 | What did you expect to see?
17 |
18 | **What is the actual behavior?**
19 |
20 | What did you see instead?
21 |
22 | ## Reproduce
23 |
24 | Create a self-contained project using the template of your choice, apply the
25 | minimum required code to result in the issue you're observing.
26 |
27 | We will close this issue if:
28 |
29 | * The repro project you share with us is complex. We can't investigate custom
30 | projects, so don't point us to such, please.
31 | * If we can not reproduce the behavior you're reporting.
32 |
33 | ## Additional Context
34 |
35 | Add any other context about the problem here.
--------------------------------------------------------------------------------
/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md:
--------------------------------------------------------------------------------
1 |
2 | ## Summary of the Pull Request
3 |
4 |
5 | ## References
6 |
7 |
8 | ## PR Checklist
9 | * [ ] Closes #xxx
10 |
11 | * [ ] Tests added/passed
12 | * [ ] Documentation updated
13 | * [ ] Schema updated.
14 | * [ ] I've discussed this with core contributors already. If not checked, I'm ready to accept this work might be rejected in favor of a different grand plan. Issue number where discussion took place: #xxx
15 |
16 |
17 | ## Detailed Description of the Pull Request / Additional comments
18 |
19 |
20 | ## Validation Steps Performed
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
9 |
51 |
52 |
53 |
54 |
55 | # :notebook_with_decorative_cover: Table of Contents
56 |
57 | - [About the Project](#star2-about-the-project)
58 | * [Screenshots](#camera-screenshots)
59 | * [Tech Stack](#space_invader-tech-stack)
60 | * [Features](#dart-features)
61 | * [Color Reference](#art-color-reference)
62 | * [Environment Variables](#key-environment-variables)
63 | - [Getting Started](#toolbox-getting-started)
64 | * [Prerequisites](#bangbang-prerequisites)
65 | * [Installation](#gear-installation)
66 | * [Running Tests](#test_tube-running-tests)
67 | * [Run Locally](#running-run-locally)
68 | * [Deployment](#triangular_flag_on_post-deployment)
69 | - [Usage](#eyes-usage)
70 | - [Roadmap](#compass-roadmap)
71 | - [Contributing](#wave-contributing)
72 | * [Code of Conduct](#scroll-code-of-conduct)
73 | - [FAQ](#grey_question-faq)
74 | - [License](#warning-license)
75 | - [Contact](#handshake-contact)
76 | - [Acknowledgements](#gem-acknowledgements)
77 |
78 |
79 |
80 |
81 | ## :star2: About the Project
82 |
83 |
84 |
85 | ### :camera: Screenshots
86 |
87 |
88 |
89 |
96 | Client
97 |
103 |
104 |
105 |
106 | Server
107 |
117 |
118 |
119 |
120 | Database
121 |
128 |
129 |
130 |
131 | DevOps
132 |
137 |
138 |
139 |
140 | ### :dart: Features
141 |
142 | - Feature 1
143 | - Feature 2
144 | - Feature 3
145 |
146 |
147 | ### :art: Color Reference
148 |
149 | | Color | Hex |
150 | | ----------------- | ------------------------------------------------------------------ |
151 | | Primary Color |  #222831 |
152 | | Secondary Color |  #393E46 |
153 | | Accent Color |  #00ADB5 |
154 | | Text Color |  #EEEEEE |
155 |
156 |
157 |
158 | ### :key: Environment Variables
159 |
160 | To run this project, you will need to add the following environment variables to your .env file
161 |
162 | `API_KEY`
163 |
164 | `ANOTHER_API_KEY`
165 |
166 |
167 | ## :toolbox: Getting Started
168 |
169 |
170 | ### :bangbang: Prerequisites
171 |
172 | This project uses Yarn as package manager
173 |
174 | ```bash
175 | npm install --global yarn
176 | ```
177 |
178 |
179 | ### :gear: Installation
180 |
181 | Install my-project with npm
182 |
183 | ```bash
184 | yarn install my-project
185 | cd my-project
186 | ```
187 |
188 |
189 | ### :test_tube: Running Tests
190 |
191 | To run tests, run the following command
192 |
193 | ```bash
194 | yarn test test
195 | ```
196 |
197 |
198 | ### :running: Run Locally
199 |
200 | Clone the project
201 |
202 | ```bash
203 | git clone https://github.com/Louis3797/awesome-readme-template.git
204 | ```
205 |
206 | Go to the project directory
207 |
208 | ```bash
209 | cd my-project
210 | ```
211 |
212 | Install dependencies
213 |
214 | ```bash
215 | yarn install
216 | ```
217 |
218 | Start the server
219 |
220 | ```bash
221 | yarn start
222 | ```
223 |
224 |
225 |
226 | ### :triangular_flag_on_post: Deployment
227 |
228 | To deploy this project run
229 |
230 | ```bash
231 | yarn deploy
232 | ```
233 |
234 |
235 |
236 | ## :eyes: Usage
237 |
238 | Use this space to tell a little more about your project and how it can be used. Show additional screenshots, code samples, demos or link to other resources.
239 |
240 |
241 | ```javascript
242 | import Component from 'my-project'
243 |
244 | function App() {
245 | return
246 | }
247 | ```
248 |
249 |
250 | ## :compass: Roadmap
251 |
252 | * [x] Todo 1
253 | * [ ] Todo 2
254 |
255 |
256 |
257 | ## :wave: Contributing
258 |
259 |
260 | 
261 |
262 |
263 |
264 | Contributions are always welcome!
265 |
266 | See `contributing.md` for ways to get started.
267 |
268 |
269 |
270 | ### :scroll: Code of Conduct
271 |
272 | Please read the [Code of Conduct](https://github.com/Louis3797/awesome-readme-template/blob/master/CODE_OF_CONDUCT.md)
273 |
274 |
275 | ## :grey_question: FAQ
276 |
277 | - Question 1
278 |
279 | + Answer 1
280 |
281 | - Question 2
282 |
283 | + Answer 2
284 |
285 |
286 |
287 | ## :warning: License
288 |
289 | Distributed under the no License. See LICENSE.txt for more information.
290 |
291 |
292 |
293 | ## :handshake: Contact
294 |
295 | Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email@email_client.com
296 |
297 | Project Link: [https://github.com/Louis3797/awesome-readme-template](https://github.com/Louis3797/awesome-readme-template)
298 |
299 |
300 |
301 | ## :gem: Acknowledgements
302 |
303 | Use this section to mention useful resources and libraries that you have used in your projects.
304 |
305 | - [Shields.io](https://shields.io/)
306 | - [Awesome README](https://github.com/matiassingers/awesome-readme)
307 | - [Emoji Cheat Sheet](https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md#travel--places)
308 | - [Readme Template](https://github.com/othneildrew/Best-README-Template)
309 |
310 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
12 | 
38 |
39 |