book-an-appointment-api

Anywhere is a group capstone project which has a React Front-End and a Ruby on Rails Back-End. Users can sign up, create places, and make reservations like AirBnB. This repo is the Back-End API for this app.

MIT License

Stars
5
Committers
4

Kanban board

Initial State of Kanban board

Our group remained the same of 4 team members throughout the whole project.

📗 Table of Contents

📖 Book an appointment | Places

The Book an appointment | Places API will provide functionality to create, read, and destroy data related to places. It will serve as the server-side component responsible for handling requests and managing the database. The React client will interact with this backend to perform actions such as creating new places and reservations, see the place details, and removing places from the system.

Link to the Front End Repo Backend Deployed link

🛠 Built With

Tech Stack

Key Features

  • Data Model

💻 Getting Started

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

Prerequisites

You need the following tools be installed in your computer:

Setup

Clone this repository to your desired folder:

cd my-prefered-folder
  
git clone https://github.com/dennis-every/book-an-appointment-api.git

Install

Install this project with:

cd book-an-appointment-api
  
bundle

💾 Database

Create the databases, run migrations, and populate it with seed data:

rails db:create
rails db:migrate
rails db:seed

Usage

To run the project run the following commands:

rails s

Run tests

To run tests, run the following command:

rspec spec --exclude-pattern "spec/integration/api/*_spec.rb"

To test the API documentation, run the following command:

rake rswag:specs:swaggerize

👥 Authors

👤 Ashmal Zahra

👤 Nilton Segura

👤 Dennis Every

👤 Diego Salamanca

🔭 Future Features

  • Complete the CRUD for places and reservations.

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ Show your support

If you like this project please give it a star 😁🌟✨

🙏 Acknowledgments

Thanks to Murat Korkmaz for the aswesome design.

📝 License

This project is MIT licensed.