An open API service indexing awesome lists of open source software.

https://github.com/inspecta/vet-clinic


https://github.com/inspecta/vet-clinic

Last synced: 5 months ago
JSON representation

Awesome Lists containing this project

README

          


Vet Clinic


# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)

# 📖 VET CLINIC

**Vet Clinic** is a Data management system for a Vet Clinic
Insert animals details into a central database, retrieve them, edit and update them or even delete the un wanted information
Data is managed through PostgreSQL Server

## 🛠 Built With

### Tech Stack

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

Database

### Key Features

> Describe between 1-3 key features of the application.

- **Insert data into the database**
- **Retrieve the data from the database**

(back to top)

## 💻 Getting Started

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

### Prerequisites

In order to run this project you need:

- Mac or PC
- PostgreSQL Server

### Setup

Clone this repository to your desired folder:

### Usage

This repository includes files with plain SQL that can be used to recreate a database:

- Use [schema.sql](./schema.sql) to create all tables.
- Use [data.sql](./data.sql) to populate tables with sample data.
- Check [queries.sql](./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!**

(back to top)

## 👥 Authors

👤 **Derrick Mulinde**

- GitHub: [@inspecta](https://github.com/inspecta)
- Twitter: [@djmulinde](https://twitter.com/djmulinde)
- LinkedIn: [derrick-mulinde](https://linkedin.com/in/derrick-mulinde)

(back to top)

## 🔭 Future Features

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

- [ ] **A UI to aid access to the database**
- [ ] **More CRUD operations**
- [ ] **Security to the database**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

If you like this project, please leave a star.

(back to top)

## 🙏 Acknowledgments

I would like to thank Microverse for providing me with the necessary reading materials that have aided me during project development.

(back to top)

## ❓ FAQ

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

- **Can I use this code?**

- Sure! It's open source, feel free to fork it.

- **Can I contribute to this project?**

- Contact me and I'll add you as a contributor. Alternatively, you can leave an issue, it'll be well appreciated.

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.

_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._

(back to top)