Skip to content

Latest commit

 

History

History
291 lines (186 loc) · 6.36 KB

README.md

File metadata and controls

291 lines (186 loc) · 6.36 KB

curriculum-databases-projects-template

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.

Getting Started

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!

📗 Table of Contents

📖 [your_project_name]

Describe your project in 1 or 2 sentences.

[your_project__name] is a...

🛠 Built With

Tech Stack

Describe the tech stack and include only the relevant sections that apply to your project.

Client
Server
Database

Key Features

Describe between 1-3 key features of the application.

  • [key_feature_1]
  • [key_feature_2]
  • [key_feature_3]

(back to top)

🚀 Live Demo

Add a link to your deployed project.

(back to top)

💻 Getting Started

Describe how a new developer could make use of your project.

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

Setup

Clone this repository to your desired folder:

Install

Install this project with:

Usage

To run the project, execute the following command:

Run tests

To run tests, run the following command:

Deployment

You can deploy this project using:

(back to top)

👥 Authors

Mention all of the collaborators of this project.

👤 Author1

👤 Author2

(back to top)

🔭 Future Features

Describe 1 - 3 features you will add to the project.

  • [new_feature_1]
  • [new_feature_2]
  • [new_feature_3]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Write a message to encourage readers to support your project

If you like this project...

(back to top)

🙏 Acknowledgments

Give credit to everyone who inspired your codebase.

I would like to thank...

(back to top)

❓ FAQ

Add at least 2 questions new developers would ask when they decide to use your project.

  • [Question_1]

    • [Answer_1]
  • [Question_2]

    • [Answer_2]

(back to top)

📝 License

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.

(back to top)