Skip to content

Mhamad-Raad/final-capstone-backend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

94 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“— Table of Contents

🚜 TravelVent

Introducing our travel app, designed to make reserving your dream trip a breeze. With just a few taps on your device, you can reserve a trip to your favourite destination. Our app's user-friendly interface allows you to get location, price, and amenities. You can also get review ratings done by other travelers to help you make the best decision for your trip. It allows users to create an account, login, and reserve a trip. It also allows users to view all available trips, and view a specific trip.

πŸ›  Built With

Tech Stack

Client
Server
Database

Key Features

Authenticate users:

  • Create an account by providing a valid name, e-mail, and password with password confirmation.
  • Once your account is created, you'll be automatically logged in and can access all of the app's features.

Trips:

  • Once you're logged in, you can browse through a list of all available trips.
  • Get the details of a specific trip by clicking on it. You can also reserve a trip from the details page.
  • On the reserve trip page, fill out the information and reserve a trip. That's it. Congratulations!

Add/Delete:

  • If you want to add a new trip, just click on the Add a Trip link in the navigation panel, and you'll be directed to a page where you can fill out a form to add a new trip.
  • If you want to delete a trip, click on the Delete a Trip link in the navigation panel. You will be redirected to a page where you can see a list of all available trips from where you can delete a trip.

Reservations:

  • To see all your reservations in one place, head to the My Reservations page. Here, you can see a list of all your reservations and get a glimpse of the details.

(back to top)

πŸš€ Front End Link

Our frontend code is built using React and Redux and is hosted on a separate repository. The frontend handles the user interface and integrates with our backend API to retrieve and display data. Click the link below to get front end code

Β Β Β Β  live link

(back to top)

πŸ” API Endpoints

For developers who want to work with our app's data, we offer a set of API endpoints that you can use and integrate into your own project. Visit the link below as an example. To get all endpoints, see the documentation below

Β Β Β Β  endpoints

(back to top)

🧾 Documentation

Here you can find a detailed documentation for the API used in the project, including endpoints, request/response formats, and authentication methods. Developers can use this documentation to integrate our service into their applications and build custom integrations

Β Β Β Β  documentation

(back to top)

βœ’ Kanban Board

We used a Kanban board to track the progress of tasks and issues. The board is designed to help visualize the status of work items, identify bottlenecks, and ensure that work is flowing smoothly.

Β Β Initial State

Frontend

frontend

Backend

backend

Β Β Final State

Frontend

frontend

Backend

backend

(back to top)

πŸ’» Getting Started

Prerequisites

In order to run this project you need:

  gem install rails 

Setup

Clone this repository to your desired folder:

  git clone [email protected]:Mhamad-Raad/final-capstone-backend.git
  cd final-capstone-backend 

Install

Install thr project dependencies with:

  bundle install
  rails db:create
  rails db:migrate

Usage

To run the project, execute the following command:

  rails server or rails s

Run tests

To run the tests, run the following command:

  rspec ./spec/models
  rspec ./spec/controllers

Deployment

You can deploy this project using:

  ./bin/dev

(back to top)

πŸ‘₯ Author

πŸ‘€ Mhamad Raad

Β Β Β Β  ruby
Β Β Β Β  ruby

πŸ‘€ Kanza Tahreem

Β Β Β Β  ruby
Β Β Β Β  ruby

πŸ‘€ Shaker Abady

Β Β Β Β  ruby
Β Β Β Β  ruby

(back to top)

πŸ”­ Future Features

  • Allow users to logout of the application
  • Handle authorization

(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 ⭐️!

(back to top)

πŸ™ Acknowledgments

Thank you to microverse for setting us on this journey.

We would like to thank Murat Korkmaz for the design guidelines.

(back to top)

πŸ“ License

This work is licensed under a Creative Commons Attribution 4.0 International License

(back to top)

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published