/travelers_hub_back-end

Primary LanguageRubyMIT LicenseMIT

Traveller's Hub Back-End

📗 Table of Contents

📖 travellers_hub_back-end

travellers_hub_back-end is a travel booking app where the user can register new accounts, login and book a set of different trip packages, users can add packages and delete them too. It is built and connected by using two different repos, including back-end(Rails) and front-end(React/Redux).

  • You can find the front-end repository here.

Kanban board

  • You can find the link to the Kanban board here
  • Here is the link to the initial Kanban board.
  • A team of four collaborated in creating this web application.

🛠 Built With

Tech Stack

Client
  • HTML, CSS
  • JavaScript
Server
  • Ruby on Rails
Database

Key Features

  • User can register new accounts and login
  • User can book a set of different trip packages
  • User can add packages and delete them too

🚀 Live Demo

(back to top)

💻 Getting Started

Prerequisites

Setup

To setup the project follow the steps:

  1. Clone this project using Git Bash:

    git clone https://github.com/yonas44/travelers_hub_back-end.git

  2. Inside the project directory, install the project's dependencies

    bundle install

  3. Create the app's database

    rails db:create

  4. Setup the app's database

    rails db:setup

  5. Setup the credentials on your local project following:

  • Run: 
           rake secret
  • Open the credentials file from the command line.
 EDITOR=nano rails credentials:edit

And paste in the following, with the key generated from running the rake secret above.

devise:
  jwt_secret_key: <rake secret key>

ctrl+x, then y, then enter to close and save if you’re using the nano editor.

Usage

  • To use the API documentation for the back-end end points, use this path to see the documentation after starting the back-end server:
http://localhost:3000/api-docs/index.html

Available Scripts

In the project directory, you can run:

  • rails server

    Runs the app local server

  • bundle exec rspec

    Launches the test runner.

👥 Author

👤 Oti Ifeanyi

👤 Selma Hamutenya

👤 Yonas Tesfu

👤 Ben Salès

👤 Kidist Dinku

(back to top)

🔭 Future Features

  • Add payment methods

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ Show your support

If you like this project give it a star!

🙏 Acknowledgments

📝 License

This project is MIT licensed.