fatima-najafi/vet-clinic-database

📗 Table of Contents

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

📖 Vet Clinic

Vet clinic is a PostgresSQL database project, where i have created an animal table, all the commands used in the terminal are added to the .sql files.

🛠 Built With

Tech Stack

This project is based on database creation. it has been created using PostgresSQL commands within the terminal. all the commands used are displayed in the files, please use them carefully, as it could affect databases you have on your machine.

Database

• PostgreSQL

Key Features

• All the commands used are in the .sql files provided
• Easy to use for future projects, as files have comments explaining what is where and how to use it

(back to top)

🚀 Live Demo

• [Live Demo Link](Coming soon!)

(back to top)

Getting Started

To set up and run this project locally, follow the steps below:

Prerequisites

Before running this project, make sure you have the following prerequisites installed:

• PostgreSQL
• Node.js
• npm

Setup

1. Clone this repository to your desired folder:

   git clone https://github.com/fatima-najafi/vet-clinic-database.git

2. Navigate to the project directory:

   cd vet_clinic

Database set up

Create a PostgreSQL database for the project (if not already created):

  createdb vet_clinic_db
  psql -U your_username -d vet_clinic_db -a -f database/schema.sql
  

Usage

To run the project:

  npm start

Run tests

To run tests after setting up the linters, run the following command:

  npx eslint "**/*.{js,jsx}"

  npx stylelint "**/*.{css,scss}"

👥 Author

👤 Fatima Najafi

• GitHub: @fatima-najafi
• Twitter: @fatima-najafi
• LinkedIn: @fatima-najafi

(back to top)

🔭 Future Features

As this project progresses, I plan to implement the following features:

• Create additional tables for related data.
• Define relationships between tables.
• Perform more advanced database operations, including joins.

Stay tuned for updates and enhancements to the vet clinic database!

(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 my page please show your support and give this page a star!

(back to top)

🙏 Acknowledgments

I would like to extend my heartfelt gratitude to Microverse for providing me with the opportunity to undertake this project. Additionally, I am immensely thankful to the code reviewers who takes the time to assess my work and provide valuable feedback, which greatly contributed to the refinement and success of the project. Your guidance and support have been invaluable throughout this endeavor, and I am truly grateful for your contributions.

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