Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/saied2035/flightfull-api

Flightfull is a travel website simulator that allows users to book flights with top airlines and add their favorite airlines. All backend operations are handled through a REST API.
https://github.com/saied2035/flightfull-api

airline-booking airline-reservation airlines jwt rails rubocop ruby-on-rails travel

Last synced: 26 days ago
JSON representation

Flightfull is a travel website simulator that allows users to book flights with top airlines and add their favorite airlines. All backend operations are handled through a REST API.

Awesome Lists containing this project

README

        

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [👥 Authors](#authors)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 Flightfull

**Flightfull** is a travel website simulator that allows users to book flights with top airlines and add their favorite airlines. All backend operations are handled through a REST API.

![flightfull](https://github.com/saied2035/flightfull-api/assets/70805060/218f57f2-56bb-4379-af04-466908cca737)

*take a look at the frontend repository [*here*](https://github.com/saied2035/flightfull)*

## 🛠 Built With

### Tech Stack

Client

Server

Database

### Key Features

- **Users can book flights to any part of the world with top airlines**
- **Users can add airlines they prefer**
- **Users can manage their airlines and reservations**

(back to top)

## 🚀 Live Demo

- [Live Demo Link](https://flightfull.netlify.app)

(back to top)

## 💻 Getting Started

If you want to get a local copy up and running, please follow these steps.

### Prerequisites

To run this project, you need:
- Rails 7
- ruby 3.1.2
- VS code editor or equivalent

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone [email protected]:saied2035/flightfull-api.git
```

### Install

Install this project with:

*note: make sure the PostgreSQL server is running*

```sh
cd fligtfull-api
bundle install
```

```sh
rails db:create db:migrate db:seed
```

### Usage

To run the project, execute the following command:

```sh
rails s -p 3001
```
(the port 3001 if you want to test against the frontend repository )

(back to top)

## 👥 Authors

👤 **Saied Gaffer**

- GitHub: [@saied2035](https://github.com/saied2035)
- Twitter: [@SaiedGaffer](https://twitter.com/SaiedGaffer)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/saiedgaffer/)

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/saied2035/flightfull-api/issues/).

(back to top)

## ⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

## 🙏 Acknowledgments

- Microverse: [microverse community](https://github.com/microverseinc)

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.

(back to top)