TourHunter API

TourHunter API is the back-end project made by our 5-member group to give users options of tours around the world to reserve and the admins to add and delete said tours. General users can create an account to be able to reserve a tour and only admins will be able to create and delete tours. Feel free to fork this project and modify it for your own use!

Deployment

You can find the app live here

Documentation

Here you can review the documentation of the API:

API Documentation

Front-end Repository

You can find the back-end API here.

Built With

• Ruby 3.1.2
• Ruby on Rails 7.0.3
• Devise 4.8.1
• Devise-JWT 0.9.0
• Pg 1.2.1
• Cloudinary 1.23.0
• Rspec-rails 5.1.2

Getting Started

To launch the project locally:

Step 1:

• Clone this repo locally using either github desktop or using the clone link provided by the green button on the top right.

• Alternatively, you can just download the complete zip file and extract the folder in your directory

Step 1:

• Set a Cloudinary account and a add cloudinary.yml with your credentials in the config folder

• In .env file, add your own credentials:

  • The master_pwd should be your mailer password to send confirmation emails.
  • The DEVISE_JWT_SECRET_KEY shoul be generated running the command: bundle exec rails secret

• Alternatively, you can just download the complete zip file and extract the folder in your directory

Step 2:

• Download all dependencies to use the Project

> bundle install
> rails db:create
> rails db:setup

Step 3:

In the project directory, you can run:

rails s

Kanban Board

• Link to the completed Tour Hunter Kanban Board
• Link to the screenshot of initial Kanban Board
• Total members: 5

Authors

👤 Mengstu Fentaw

• Github: @mengiefen
• Twitter: @MengistuFentaw
• Linkedin: @mengefen

👤 Leonardo Pires Goss

• GitHub: @leopiresgoss
• Twitter: @leonardopgoss
• Linkedin: @leonardogoss

👤 Thiago Allan Porro Ponce

• GitHub: @Thi-Ponce
• Twitter: @Thi_ponce
• LinkedIn: @thiago-ponce

👤 Behnam Aghaali

• GitHub: @Behnam1369
• LinkedIn: @Behnam-Aghaali
• Twitter: @Behnamagh1369

👤 Yersel Hurtado

• GitHub: @yersel500
• LinkedIn: Yersel Hurtado
• Twitter: @YerselHurtado

🤝 Contributing

Contributions, issues, and feature requests are welcome and highly encouraged! We feel that your input is what helps us grow so you're always Welcome :)

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

• Thank you to all our peers who helped us out through this wonderful journey at Microverse. 🌥️
• The creator of the design guidelines Murat Korkmaz on Behance.

📝 License

This project is MIT licensed.