Book Destinations Api

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
    • Kanban Board
  • 🚀 Live Demo
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 [Book Destinations Api]

[Book Destinations Api] is a Api only application that acts as the server for the client app. The application provides data through api and also handle user authentication. Here is a link to the Client App. FrontEnd

🛠 Built With

Tech Stack

Ruby on Rails

• Rails

Database

• PostgreSQL

Key Features

• [Database schema containing the User data, Destination and Reserve]
• [Api only application]

(back to top)

Kanban Board

• Here is the link to the projects Kanban board we set up.Click here.
• We started collaborating in a team of 3 but currently, we are 2 members.

(back to top)

🚀 Live Demo

Not live yet...

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

Example command:

 gem install rails

Setup

Clone this repository to your desired folder:

Example commands:

  cd book-destinations-api
  git clone https://github.com/obimbo07/book-destinations-api.git

Install

Install this project with:

Example command:

  cd book-destinations-api
  gem install

Usage

To run the project, execute the following command:

Example command:

1. Remove config/master.key and config/credentials.yml.enc if they exist.
2. Run in the terminal: EDITOR=code rails credentials:edit
3. Close the editor that opens.
4. This command will create a new master.key and credentials.yml.enc if they do not exist.

• rails db:create, rails db:migrate

  rails server

Run tests

To run tests, run the following command:

Example command:

  bin/rails test 

Deployment

You can deploy this project using:

render

(back to top)

👥 Authors

👤 Austin Obimbo

• GitHub: @obimbo07
• LinkedIn: LinkedIn
• WellFound: WellFound

👤 Vikas Chib

• GitHub: @vikas924
• Twitter: @vikas410190
• LinkedIn: Vikas Singh

(back to top)

🔭 Future Features

• [Implement payment models and logic]

(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 give it a Star and come contribute new features. We welcome you all.

(back to top)

🙏 Acknowledgments

• We would like to thank microverse for their guidance on the project.
• We also love to thank the Murat Korkmaz on Behance who provided us with the design.

(back to top)

❓ FAQ (OPTIONAL)

Add at least 2 questions new developers would ask when they decide to use your project.

• [Can I contribute?]

  • [Yes, you are welcome to contribute, We value pair programming]

(back to top)

📝 License

This project is MIT licensed.

(back to top)