Chimoneg27/Clinic-ERD

📗 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
• 📝 License

📖 [Clinic-ERD]

[Clinic-ERD] is a schema for a clinic database. It is a project for the Microverse Ruby curriculum.

🛠 Built With

Tech Stack

Database

• PostgreSQL

Key Features

• [Patient data]
• [Appointment scheduling]
• [Billing]

(back to top)

💻 Getting Started

To get a local copy of the Clinic-ERD project up and running, follow these steps:

Prerequisites

In order to run this project, you need to have PostgreSQL installed on your system. If you haven't already installed PostgreSQL, you can download and install it from the official website: PostgreSQL Downloads

Setup

1. Clone this repository to your desired folder using the following command:

   git clone https://github.com/Chimoneg27/Clinic-ERD.git
   

2. Navigate to the project folder

   cd Clinic-ERD
   

Install

1. Create a PostgreSQL database for the project. You can do this using the PostgreSQL command line or a graphical tool like pgAdmin.

2. Configure the database connection by modifying the config/database.yml file with your database credentials.

3. Install the required gems by running the following command:

   bundle install
   

4. Run the migrations to create the database tables:

    rails db:migrate
    rails db:migrate

Usage

To run the project, execute the following command:

Example command:

  rails server

Your Clinic-ERD application should now be accessible by visiting http://localhost:3000 in your web browser.

Run tests

To run tests, run the following command:

Example command:

  bin/rails test test/models/article_test.rb

Deployment

You can deploy this project to a production server of your choice following the standard deployment procedures for Ruby on Rails applications.

(back to top

👥 Authors

👤 Garvin Chimone

• GitHub: @Chimoneg27
• Twitter: @GarvinChimone
• LinkedIn: Garvin Chimone

👤 Fombi Magnus-Favour

• GitHub: Fombi-Favour
• Twitter: @FavourFombi
• LinkedIn: Fombi Favour

(back to top)

🔭 Future Features

• [More query options]
• [More appointment options]
• [More billing options]
• [More patients]

(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, give it a ⭐️!

(back to top)

🙏 Acknowledgments

I would like to thank the Microverse team for making this possible.

(back to top)

📝 License

This project is MIT licensed.

(back to top)