over-geek/boat-cruise-reservation-api

Boat Reservation API

📗 Table of Contents

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

📖 Boat-Reservation-API

Boat App API is an API to retrieve boats.

🛠 Built With

Tech Stack

Server

• Ruby

Database

• PostgreSQL

Key Features

• Add reservations for a boat
• User Login
• Delete added boats

(back to top)

🚀 Live Demo

• N/A

(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:

• To install ruby on your PC. You can read this documentation on how to do so
• To install sqlite3 on your PC. You can read this documentation on how to do so
• Know how to navigate directories or folders at the CLI.
• Know how to get the URL(https/ssh) of a repository on GitHub.
• You should have a code editor installed, preferably VSCode.
• In order to run this project you need:

Setup

Clone this repository to your desired folder:

  git clone https://github.com/thasipablo/boat-cruise-reservation-api.git

Install

Install this project with:

  cd boat-cruise-reservation-api
  bundle install

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

 rspec spec

Deployment

You can deploy this project using:

(back to top)

👥 Authors

👤 Agyare Kissi Kenneth

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Franck Kalunga

• GitHub: francksefu
• Twitter: francksefu
• LinkedIn: francksefu

👤 Pablo Thasi

• GitHub: thasipablo

👤 Macherki Nessrine

• GitHub: @githubhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [] User profiles - allow users to create a profile page where they can add a profile picture, bio, and other information about themselves.

(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 me ⭐

(back to top)

🙏 Acknowledgments

We would like to thank Murat Korkmaz for this project design idea.

(back to top)

📝 License

This project is MIT licensed.

(back to top)