Giter VIP home page Giter VIP logo

ashmalzahra / book-an-appointment-api Goto Github PK

View Code? Open in Web Editor NEW

This project forked from dennis-every/book-an-appointment-api

2.0 0.0 0.0 204 KB

A Rails 7 backend for the book an appointment app, responsible for handling requests and managing the database. It interacts with React frontend to perform various actions, including creating new places and reservations, viewing place details, and removing places from the system. Built with Ruby on Rails on backend and React for frontend.

License: MIT License

Shell 0.30% Ruby 95.94% HTML 0.43% Dockerfile 3.32%
api-endpoints backend controller postgresql-database rspec-testing ruby-on-rails api-documentation

book-an-appointment-api's Introduction

Book an appointment | Places


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

Client
Server
Database

Key Features

  • Data Model

(back to top)

(back to top)

๐Ÿ’ป 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

(back to top)

๐Ÿ‘ฅ Authors

๐Ÿ‘ค Ashmal Zahra

๐Ÿ‘ค Nilton Segura

๐Ÿ‘ค Dennis Every

๐Ÿ‘ค Diego Salamanca

(back to top)

๐Ÿ”ญ Future Features

  • Complete the CRUD for places and reservations.

(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 please give it a star ๐Ÿ˜๐ŸŒŸโœจ

(back to top)

๐Ÿ™ Acknowledgments

Thanks to Murat Korkmaz for the aswesome design.

(back to top)

๐Ÿ“ License

This project is MIT licensed.

(back to top)

book-an-appointment-api's People

Contributors

ashmalzahra avatar dennis-every avatar nkaleth avatar dfsalam avatar

Stargazers

Abraha Kahsay avatar Lincoln Gibson avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.