An awesome README template to jumpstart your projects!
View Project
·
Report Bug
·
Request Feature
Table of Contents
There are many great README templates available on GitHub, however, I didn't find one that really suit my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need -- I think this is it.
Here's why:
- Your time should be focused on creating something amazing. A project that solves a problem and helps others
- You shouldn't be doing the same tasks over and over like creating a README from scratch
- You should element DRY principles to the rest of your life 😄
Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have have contributed to expanding this template!
A list of commonly used resources that I find helpful are listed in the acknowledgements.
- Owner
- Manager
- Staff
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
This is an example of how to list things you need to use the software and how to install them.
- npm
npm install npm@latest -g
- Get a free API Key at https://example.com
- Clone the repo
git clone https://github.com/your_username_/Project-Name.git
- Install NPM packages
npm install
- Enter your API in
config.jsconst API_KEY = 'ENTER YOUR API';
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
For more examples, please refer to the Documentation
See the open issues for a list of proposed features (and known issues).
| Full name | Student ID | Role |
|---|---|---|
| Ngô Dương Kha | 1950117 | Leader |
| Lê Thành Luân | 19520702 | UX/UI |
| Dương Hoài Nam | 19521868 | Developer |
| Nguyễn Vĩnh Hoàng Phúc | 19520225 | Database |
Distributed under the MIT License. See LICENSE for more information.
Ngô Dương Kha - Facebook - 19520117@gm.uit.edu.vn
Project Link: https://github.com/ngoduongkha/Hotel-JustFriend