Skip to content

amita-roy/Appointment-booking-app-backend

Repository files navigation

Encapture API (Final Capstone Booking Appointments)

Built backend in Ruby on Rails for final capstone project. For this project I have created a web app for booking an appointment for salon services.

  • Using namespace and versioning for all the routes
  • Using api authentication with json web tokens
  • Using Active Model Serializers with josn_api adapter for json data for consistency
  • User without login can access the services end point
  • Only logged in user can access the appointments end point and see their own appointments
  • Using factory bot for creating a mock user

Screenshots

  • Appointments Endpoint
  • Services Endpoint

API Endpoints

  • api/v1/auth/signin (post)
  • api/v1/auth/signup (post)
  • api/v1/appointments (get, post)
  • api/v1/services (get)

Built With

  • Ruby
  • Ruby on Rails
  • Postgresql
  • JWT (Json Web Token)
  • Devise
  • Active Model Serializers
  • Factory Bot
  • Rspec
  • Capybara
  • rubocop
  • heroku

Live Demo

Encapture Backend

Live demo for frontend

Frontend Live

Repository for frontend

Frontent Repository

Prerequisites

  • Ruby

  • Rails

  • Postgresql

Getting Started

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

Setup

  • Clone this repository with git clone git@github.com:Amita-Roy/Encapture-API.git using your terminal or command line.
  • Change to the project directory by entering cd encapture-api in the terminal
  • Next run bundle install to install the necessary dependencies
  • run rails active_storage:install
  • run rails db:create
  • Run rails db:migrate to setup your local database.
  • Run rails db:seed to get seeded data for project.
  • Finally run rails server to start the application.

Usage

Start server with:

    rails server

Open http://localhost:3000/ in your browser.

Run tests

for test formatting add below script in .rspec file

    --format documentation
    --color

To run all the tests run below script in the terminal

rspec

Author

👤 Amita Roy

🤝 Contributing

Contributions, issues and feature requests are welcome!

Show your support

Give a ⭐️ if you like this project!

📝 License

About

An Appointment booking app backend for salon services

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published