/vet-appointments-rails

A vet appointments API built with Ruby on Rails

Primary LanguageRuby

Vet-Appointments App

This is an app in which you can reserve an appointment with a Veterinarian, create a Doctor, delete a Doctor and show all your appointments. This app was created separating the Fron-End and the Back-End in two repositories. This is the repository of the back-end API and you can find the Front-End repository here and the documentation of the API here

image

KanBan Board

Built With

  • Ruby
  • Rails
  • Rspec
  • Rswag

Getting Started

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

Prerequisites

  • You should have ruby installed in your machine, you can follow the steps given by the official documentation.

  • You should have a postgres user with superuser permissions. you can refer to the official postgres documentation to create or update a role.

Setup

First, you must clone this repository locally running this command:

git clone git@github.com:rskinnerc/vet-appointments-rails.git

and navigate to the cloned directory:

cd vet-appointments-rails

Install

Once inside the project directory, you should install all project dependencies:

  • Install bundler:
gem install bundler
  • Install project dependencies
bundle install
  • Set up database configuration in config/database.yml and create it
rails db:create
  • Run Database Migrations
rails db:migrate

Usage

You can get the app running locally by opening a local server:

bin/rails server

Run tests

If you're on a linux-based system, you could run the executable file to run all specs:

bin/rspec

Windows users have to specify ruby in this case:

ruby bin/rspec

Authors

👤 Ronald Skinner

👤 Juan Francisco Rosario Suli

👤 Maximiliano Diaz

👤 Alejandro Neira

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

📝 License

This project is MIT licensed.