├── MIT.md
├── README.md
├── app_screenshot.png
└── murple_logo.png


/MIT.md:
--------------------------------------------------------------------------------
 1 | ## Copyright 2021, [YOUR NAME]
 2 | 
 3 | ###### Please delete this line and the next one
 4 | ###### APP TYPE can be a webpage/website, a web app, a software and so on
 5 | 
 6 | Permission is hereby granted, free of charge, to any person obtaining a copy of this [APP TYPE] and associated documentation files, to deal in the [APP TYPE] without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the [APP TYPE], and to permit persons to whom the [APP TYPE] is furnished to do so, subject to the following conditions:
 7 | 
 8 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the [APP TYPE].
 9 | 
10 | THE [APP TYPE] 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 [APP TYPE] OR THE USE OR OTHER DEALINGS IN THE [APP TYPE].
11 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | <a name="readme-top"></a>
  2 | 
  3 | <!--
  4 | HOW TO USE:
  5 | This is an example of how you may give instructions on setting up your project locally.
  6 | 
  7 | Modify this file to match your project and remove sections that don't apply.
  8 | 
  9 | REQUIRED SECTIONS:
 10 | - Table of Contents
 11 | - About the Project
 12 |   - Built With
 13 |   - Live Demo
 14 | - Getting Started
 15 | - Authors
 16 | - Future Features
 17 | - Contributing
 18 | - Show your support
 19 | - Acknowledgements
 20 | - License
 21 | 
 22 | OPTIONAL SECTIONS:
 23 | - FAQ
 24 | 
 25 | After you're finished please remove all the comments and instructions!
 26 | -->
 27 | 
 28 | <div align="center">
 29 |   <!-- You are encouraged to replace this logo with your own! Otherwise you can also remove it. -->
 30 |   <img src="murple_logo.png" alt="logo" width="140"  height="auto" />
 31 |   <br/>
 32 | 
 33 |   <h3><b>Microverse README Template</b></h3>
 34 | 
 35 | </div>
 36 | 
 37 | <!-- TABLE OF CONTENTS -->
 38 | 
 39 | # 📗 Table of Contents
 40 | 
 41 | - [📖 About the Project](#about-project)
 42 |   - [🛠 Built With](#built-with)
 43 |     - [Tech Stack](#tech-stack)
 44 |     - [Key Features](#key-features)
 45 |   - [🚀 Live Demo](#live-demo)
 46 | - [💻 Getting Started](#getting-started)
 47 |   - [Setup](#setup)
 48 |   - [Prerequisites](#prerequisites)
 49 |   - [Install](#install)
 50 |   - [Usage](#usage)
 51 |   - [Run tests](#run-tests)
 52 |   - [Deployment](#triangular_flag_on_post-deployment)
 53 | - [👥 Authors](#authors)
 54 | - [🔭 Future Features](#future-features)
 55 | - [🤝 Contributing](#contributing)
 56 | - [⭐️ Show your support](#support)
 57 | - [🙏 Acknowledgements](#acknowledgements)
 58 | - [❓ FAQ (OPTIONAL)](#faq)
 59 | - [📝 License](#license)
 60 | 
 61 | <!-- PROJECT DESCRIPTION -->
 62 | 
 63 | # 📖 [your_project_name] <a name="about-project"></a>
 64 | 
 65 | > Describe your project in 1 or 2 sentences.
 66 | 
 67 | **[your_project__name]** is a...
 68 | 
 69 | ## 🛠 Built With <a name="built-with"></a>
 70 | 
 71 | ### Tech Stack <a name="tech-stack"></a>
 72 | 
 73 | > Describe the tech stack and include only the relevant sections that apply to your project.
 74 | 
 75 | <details>
 76 |   <summary>Client</summary>
 77 |   <ul>
 78 |     <li><a href="https://reactjs.org/">React.js</a></li>
 79 |   </ul>
 80 | </details>
 81 | 
 82 | <details>
 83 |   <summary>Server</summary>
 84 |   <ul>
 85 |     <li><a href="https://expressjs.com/">Express.js</a></li>
 86 |   </ul>
 87 | </details>
 88 | 
 89 | <details>
 90 | <summary>Database</summary>
 91 |   <ul>
 92 |     <li><a href="https://www.postgresql.org/">PostgreSQL</a></li>
 93 |   </ul>
 94 | </details>
 95 | 
 96 | <!-- Features -->
 97 | 
 98 | ### Key Features <a name="key-features"></a>
 99 | 
100 | > Describe between 1-3 key features of the application.
101 | 
102 | - **[key_feature_1]**
103 | - **[key_feature_2]**
104 | - **[key_feature_3]**
105 | 
106 | <p align="right">(<a href="#readme-top">back to top</a>)</p>
107 | 
108 | <!-- LIVE DEMO -->
109 | 
110 | ## 🚀 Live Demo <a name="live-demo"></a>
111 | 
112 | > Add a link to your deployed project.
113 | 
114 | - [Live Demo Link](https://yourdeployedapplicationlink.com)
115 | 
116 | <p align="right">(<a href="#readme-top">back to top</a>)</p>
117 | 
118 | <!-- GETTING STARTED -->
119 | 
120 | ## 💻 Getting Started <a name="getting-started"></a>
121 | 
122 | > Describe how a new developer could make use of your project.
123 | 
124 | To get a local copy up and running, follow these steps.
125 | 
126 | ### Prerequisites
127 | 
128 | In order to run this project you need:
129 | 
130 | <!--
131 | Example command:
132 | 
133 | ```sh
134 |  gem install rails
135 | ```
136 |  -->
137 | 
138 | ### Setup
139 | 
140 | Clone this repository to your desired folder:
141 | 
142 | <!--
143 | Example commands:
144 | 
145 | ```sh
146 |   cd my-folder
147 |   git clone git@github.com:myaccount/my-project.git
148 | ```
149 | --->
150 | 
151 | ### Install
152 | 
153 | Install this project with:
154 | 
155 | <!--
156 | Example command:
157 | 
158 | ```sh
159 |   cd my-project
160 |   gem install
161 | ```
162 | --->
163 | 
164 | ### Usage
165 | 
166 | To run the project, execute the following command:
167 | 
168 | <!--
169 | Example command:
170 | 
171 | ```sh
172 |   rails server
173 | ```
174 | --->
175 | 
176 | ### Run tests
177 | 
178 | To run tests, run the following command:
179 | 
180 | <!--
181 | Example command:
182 | 
183 | ```sh
184 |   bin/rails test test/models/article_test.rb
185 | ```
186 | --->
187 | 
188 | ### Deployment
189 | 
190 | You can deploy this project using:
191 | 
192 | <!--
193 | Example:
194 | 
195 | ```sh
196 | 
197 | ```
198 |  -->
199 | 
200 | <p align="right">(<a href="#readme-top">back to top</a>)</p>
201 | 
202 | <!-- AUTHORS -->
203 | 
204 | ## 👥 Authors <a name="authors"></a>
205 | 
206 | > Mention all of the collaborators of this project.
207 | 
208 | 👤 **Author1**
209 | 
210 | - GitHub: [@githubhandle](https://github.com/githubhandle)
211 | - Twitter: [@twitterhandle](https://twitter.com/twitterhandle)
212 | - LinkedIn: [LinkedIn](https://linkedin.com/in/linkedinhandle)
213 | 
214 | 👤 **Author2**
215 | 
216 | - GitHub: [@githubhandle](https://github.com/githubhandle)
217 | - Twitter: [@twitterhandle](https://twitter.com/twitterhandle)
218 | - LinkedIn: [LinkedIn](https://linkedin.com/in/linkedinhandle)
219 | 
220 | <p align="right">(<a href="#readme-top">back to top</a>)</p>
221 | 
222 | <!-- FUTURE FEATURES -->
223 | 
224 | ## 🔭 Future Features <a name="future-features"></a>
225 | 
226 | > Describe 1 - 3 features you will add to the project.
227 | 
228 | - [ ] **[new_feature_1]**
229 | - [ ] **[new_feature_2]**
230 | - [ ] **[new_feature_3]**
231 | 
232 | <p align="right">(<a href="#readme-top">back to top</a>)</p>
233 | 
234 | <!-- CONTRIBUTING -->
235 | 
236 | ## 🤝 Contributing <a name="contributing"></a>
237 | 
238 | Contributions, issues, and feature requests are welcome!
239 | 
240 | Feel free to check the [issues page](../../issues/).
241 | 
242 | <p align="right">(<a href="#readme-top">back to top</a>)</p>
243 | 
244 | <!-- SUPPORT -->
245 | 
246 | ## ⭐️ Show your support <a name="support"></a>
247 | 
248 | > Write a message to encourage readers to support your project
249 | 
250 | If you like this project...
251 | 
252 | <p align="right">(<a href="#readme-top">back to top</a>)</p>
253 | 
254 | <!-- ACKNOWLEDGEMENTS -->
255 | 
256 | ## 🙏 Acknowledgments <a name="acknowledgements"></a>
257 | 
258 | > Give credit to everyone who inspired your codebase.
259 | 
260 | I would like to thank...
261 | 
262 | <p align="right">(<a href="#readme-top">back to top</a>)</p>
263 | 
264 | <!-- FAQ (optional) -->
265 | 
266 | ## ❓ FAQ (OPTIONAL) <a name="faq"></a>
267 | 
268 | > Add at least 2 questions new developers would ask when they decide to use your project.
269 | 
270 | - **[Question_1]**
271 | 
272 |   - [Answer_1]
273 | 
274 | - **[Question_2]**
275 | 
276 |   - [Answer_2]
277 | 
278 | <p align="right">(<a href="#readme-top">back to top</a>)</p>
279 | 
280 | <!-- LICENSE -->
281 | 
282 | ## 📝 License <a name="license"></a>
283 | 
284 | This project is [MIT](./LICENSE) licensed.
285 | 
286 | _NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._
287 | 
288 | <p align="right">(<a href="#readme-top">back to top</a>)</p>
289 | 


--------------------------------------------------------------------------------
/app_screenshot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/calebchris000/readme-template/e6bb90ae016bd5026a5b26a4e68d057046db7105/app_screenshot.png


--------------------------------------------------------------------------------
/murple_logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/calebchris000/readme-template/e6bb90ae016bd5026a5b26a4e68d057046db7105/murple_logo.png


--------------------------------------------------------------------------------