Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dennis-every/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.
https://github.com/dennis-every/book-an-appointment-api
rails7 ruby
Last synced: 7 days ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/dennis-every/book-an-appointment-api
- Owner: dennis-every
- License: mit
- Created: 2023-06-07T15:47:28.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-05T03:02:00.000Z (11 months ago)
- Last Synced: 2025-01-14T11:14:11.554Z (13 days ago)
- Topics: rails7, ruby
- Language: Ruby
- Homepage: https://reservation-places.onrender.com/api/v1/places
- Size: 177 KB
- Stars: 5
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Book an appointment | Places
## Kanban board
- [Kanban board Project link](https://github.com/users/dennis-every/projects/3/views/2)
### Initial State of Kanban board
Our group remained the same of 4 team members throughout the whole project.
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)
# 📖 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](https://github.com/dennis-every/book-an-appointment-front-end)
[Backend Deployed link](http://boiling-taiga-49294-bcedd3da6f09.herokuapp.com/api-docs/index.html)
Client
Server
Database
- **Data Model**
To get a local copy up and running follow these simple example steps.
### Prerequisites
> You need the following tools be installed in your computer:
> - [Rails](https://guides.rubyonrails.org/)
> - [Git](https://www.linode.com/docs/guides/how-to-install-git-on-linux-mac-and-windows/)
> - [Ruby](https://github.com/microverseinc/curriculum-ruby/blob/main/simple-ruby/articles/ruby_installation_instructions.md)
### Setup
Clone this repository to your desired folder:
```sh
cd my-prefered-folder
git clone https://github.com/dennis-every/book-an-appointment-api.git
```
### Install
Install this project with:
```sh
cd book-an-appointment-api
bundle
```
### 💾 Database
Create the databases, run migrations, and populate it with seed data:
```sh
rails db:create
rails db:migrate
rails db:seed
```
### Usage
To run the project run the following commands:
```sh
rails s
```
### Run tests
To run tests, run the following command:
```sh
rspec spec --exclude-pattern "spec/integration/api/*_spec.rb"
```
To test the API documentation, run the following command:
```sh
rake rswag:specs:swaggerize
```
👤 **Ashmal Zahra**
- GitHub: [@ashmalzahra](https://github.com/ashmalzahra)
- Twitter: [@AshmalZahraa](https://twitter.com/AshmalZahraa)
- LinkedIn: [ashmal-zahra](https://www.linkedin.com/in/ashmal-zahra)
👤 **Nilton Segura**
- GitHub: [@Nkaleth](https://github.com/Nkaleth)
- Twitter: [@NoeSeguraL](https://twitter.com/NoeSeguraL)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/niltonsegura/)
👤 **Dennis Every**
- GitHub: [@dennis-every](https://github.com/dennis-every)
- Twitter: [@dennis_every](https://twitter.com/dennis_every)
- LinkedIn: [dennis-every](https://www.linkedin.com/in/dennis-every/)
👤 **Diego Salamanca**
- GitHub: [dfsalam](https://github.com/dfsalam)
- LinkedIn: [Diego Salamanca](https://www.linkedin.com/in/dfsalamdev/)
- [ ] **Complete the CRUD for places and reservations.**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/dennis-every/book-an-appointment-api/issues).
If you like this project please give it a star 😁🌟✨
Thanks to [Murat Korkmaz](https://www.behance.net/muratk) for the aswesome [design](https://www.behance.net/gallery/26425031/Vespa-Responsive-Redesign).
This project is [MIT](./LICENSE) licensed.