📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 [Clinic Database]

[Clinic Database] project contains a relational database created following the diagram below

🛠 Built With

Tech Stack

Database

• PostgreSQL

Key Features

• [User can observe and analyze data]
• [Can modify the table]
• [Using PostgreSQL]

(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:

• PostgreSQL installed and configured.

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/flemton/clinic-database.git

Install

Install this project with:

  npm install

Usage

To run the project, execute the following command:

• Start the PostgreSQL server.
• Create a new database for the Vet Clinic project.
• Import the database schema and initial data from the SQL files provided (schema.sql and data.sql).
• Configure the database connection in the application code, if necessary.

Run tests

To run tests, run the following command:

  npm test

👥 Authors

👤 Osman Alhassan

• GitHub: @flemton
• Twitter: @oalhassan847
• LinkedIn: Alhassan Osman

👤 Federica Ulzurrun

• GitHub: @federicaulzurrun
• Twitter: @ulzurrunfede
• LinkedIn: Federica Ulzurrun

(back to top)

🔭 Future Features

• [Developing the UI]
• [Deploying the site]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project...

(back to top)

🙏 Acknowledgments

I would like to thank...

(back to top)

❓ FAQ

• [How do I use PostgreSQL in the terminal?]

  • [After opening the PostgreSQL terminal (psql) you'll be asked for a server name to connect]
  • [Press enter if you've not changed the server name (shows locahost)]
  • [Next is database name, type vet_clinic and press enter if you've already created the vet_clinic database]
  • [Next prompt is port, press enter]
  • [Enter username, in the next or press enter if not sure]
  • [Lastly enter your PostgreSQL user password when prompted and press enter]

• [How do I switch a database?]

  • \c [db-name] where [db-name] is your database name, example \c vet_clinic

(back to top)

📝 License

This project is MIT licensed.

(back to top)