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.

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
• 👥 Authors
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 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.

take a look at the frontend repository here

🛠 Built With

Tech Stack

Client

• ReactJS
• Redux toolkit
• React Router
• TailwindCSS

Server

• Ruby on Rails

Database

• PostgreSQL (development)
• CockroachDB (production)

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

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

  cd my-folder
  git clone git@github.com:saied2035/flightfull-api.git

Install

Install this project with:

note: make sure the PostgreSQL server is running

  cd fligtfull-api
  bundle install

  rails db:create db:migrate db:seed

Usage

To run the project, execute the following command:

  rails s -p 3001

(the port 3001 if you want to test against the frontend repository )

(back to top)

👥 Authors

👤 Saied Gaffer

• GitHub: @saied2035
• Twitter: @SaiedGaffer
• LinkedIn: LinkedIn

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

• Microverse: microverse community

(back to top)

📝 License

This project is MIT licensed.

(back to top)