This template should be used for database related projects at Microverse. Generate your own repository, update this README and edit all files content while working on projects. You should not be adding any new files unless asked otherwise.
This repository includes files with plain SQL that can be used to recreate a database:
- Use schema.sql to create all tables.
- Use data.sql to populate tables with sample data.
- Check queries.sql for examples of queries that can be run on a newly created database. Important note: this file might include queries that make changes in the database (e.g., remove records). Use them responsibly!
- π About the Project
- π» Getting Started
- π₯ Authors
- π Future Features
- π€ Contributing
- βοΈ Show your support
- π Acknowledgements
- β FAQ
- π License
Describe your project in 1 or 2 sentences.
[your_project__name] is a...
Describe the tech stack and include only the relevant sections that apply to your project.
Client
Server
Database
Describe between 1-3 key features of the application.
- [key_feature_1]
- [key_feature_2]
- [key_feature_3]
Add a link to your deployed project.
Describe how a new developer could make use of your project.
To get a local copy up and running, follow these steps.
In order to run this project you need:
Clone this repository to your desired folder:
Install this project with:
To run the project, execute the following command:
To run tests, run the following command:
You can deploy this project using:
Mention all of the collaborators of this project.
π€ Author1
- GitHub: @githubhandle
- Twitter: @twitterhandle
- LinkedIn: LinkedIn
π€ Author2
- GitHub: @githubhandle
- Twitter: @twitterhandle
- LinkedIn: LinkedIn
Describe 1 - 3 features you will add to the project.
- [new_feature_1]
- [new_feature_2]
- [new_feature_3]
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
Write a message to encourage readers to support your project
If you like this project...
Give credit to everyone who inspired your codebase.
I would like to thank...
Add at least 2 questions new developers would ask when they decide to use your project.
-
[Question_1]
- [Answer_1]
-
[Question_2]
- [Answer_2]
This project is MIT licensed.
NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.