📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
  • Kanban
• 👥 Authors
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Jet-Log-BackEnd

Jet-Log-BackEnd is a backend api used by jet-log-frontend to enable the user see available planes, reserve a plane and see the reservations. The admin can also add or delete a plane from the database

🛠 Built With

Tech Stack

Technologies

• Ruby
• Ruby on Rails

Database

• PostgreSQL

Key Features

• [Authentication-API]
• [Aeroplanes-API]
• [Reservations-API]

(back to top)

(back to top)

💻 Getting Started

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

• Clone the back-end repository by writing https://github.com/tkz96/jet-log-frontend
• Clone the front-end repository by writing https://github.com/tkz96/jet-log-frontend.git
• This is the link to the Jetlog FrontEnd
• Run bundle install to install the project's dependencies
• Add your database username and password and write rails db:create to create the database
• Run rails db:migrate to migrate the tables to the created database
• Run rails db:seed to populate the tables with the available data
• Run rails server -p 3000 to open the local host

Prerequisites

In order to run this project you need:

• Install PostgreSQL in your machine
• install Ruby and Ruby on rails
• Install your preferred IDE(Visual Studio is highly recommended)
• Then run:

 bundle install

Setup

• Clone this repository to your desired folder
• Navigate to the cloned repository and follow the aforementioned steps to get started

Install

Install this project with:

• PostgreSQL
• Ruby
• Ruby on Rails

Usage

To run the project, execute the following command:

rails server -p 3000

Run tests

To run tests, run the following command:

rspec <relative path to the test file>

Deployment

• The project has been delpoyed at https://jet-log.herokuapp.com

Kanban

• This is the link to the Kanban Board
• This is the link to the Kanban Board screenshots
• Our team had 5 members

(back to top)

👥 Authors

👤 Talha Zuberi

• GitHub: @tkz96
• Twitter: @tkz96
• LinkedIn: Talha Zuberi

👤 Bengi Genç

• GitHub: @bengigo
• Twitter: @bengigo
• LinkedIn: Bengi

👤 Sharon Odhiambo

• GitHub: @sharon-odhiambo
• Twitter: @SharonVictor16
• LinkedIn: Sharon Odhiambo

👤 Aquinas Moriasi

• GitHub: Aquinas Moriasi
• Twitter: @Aquinas747
• LinkedIn: Aquinas Moriasi

👤 Berkay Akbas

• GitHub: @berkay-akbas
• LinkedIn: Berkay Akbas

(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 ⭐ at jetlog-backend and jetlog-frontend

(back to top)

🙏 Acknowledgments

• Original design by Murat Korkmaz on Behance.

(back to top)

📝 License

This project is MIT licensed.

(back to top)