Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rubydevi/jetlogix-backend
JetLogixโs backend is a robust Rails application utilizing PostgreSQL database, managing private jet reservations.
https://github.com/rubydevi/jetlogix-backend
api authentication devise postgresql rails ruby
Last synced: about 4 hours ago
JSON representation
JetLogixโs backend is a robust Rails application utilizing PostgreSQL database, managing private jet reservations.
- Host: GitHub
- URL: https://github.com/rubydevi/jetlogix-backend
- Owner: rubydevi
- License: mit
- Created: 2023-10-31T09:54:33.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-17T11:59:44.000Z (12 months ago)
- Last Synced: 2024-08-06T17:08:39.624Z (3 months ago)
- Topics: api, authentication, devise, postgresql, rails, ruby
- Language: Ruby
- Homepage: https://jetlogix.onrender.com/
- Size: 389 KB
- Stars: 0
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
JetLogix
ER Diagrma
# ๐ Table of Contents
- [๐ About the Project](#about-project)
- [๐ Front End](#front-end)
- [๐ Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [๐ Live Demo](#live-demo)
- [๐ป Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Setup .ENV](#setup-env)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [๐ Kanban Board ](#kanban-board)
- [๐ฅ Authors](#authors)
- [๐ญ Future Features](#future-features)
- [๐ค Contributing](#contributing)
- [โญ๏ธ Show your support](#support)
- [๐ Acknowledgements](#acknowledgements)
- [๐ Attribution](#attribution)
- [โ FAQ](#faq)
- [๐ License](#license)JetLogixโs backend is a robust Rails application utilizing PostgreSQL database, managing private jet reservations. It exposes efficient API endpoints to JetLogix front, providing access to the applicationโs database and ensuring secure storage and retrieval private jets, user's, and reservation data.
[Click here to see the JetLogix front end](https://github.com/rubydevi/jetlogix-frontend)
> Exposes robust API endpoints to manage and access the applicationโs rich database.
> Controllers to manage jets and reservations, allowing CRUD (Create, Read, Update, Delete) operations.
> Secure user authentication and profile management
> API documentation
> Live Demo of this application:
- [Live Demo Link](https://jetlogix.onrender.com/)
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
### Setup
Clone this repository to your desired folder:
```sh
cd my-folder
git clone https://github.com/rubydevi/jetlogix-backend.git
```
### Install
Install this project with:
```sh
cd my-project
bundle install
```
### setup-env
1. create an env file by running the following command
```sh
touch .env
```
Or create the .env file manually at the root of the application.
2. open databse.yml file and Find the default: &default section in the file and copy the credentials into your .env file:
```sh
DATABASE_USERNAME=your_username
DATABASE_PASSWORD=your_password
```
### Usage
To run the project, you will need to execute:
```sh
rails credentials:edit
rails db:create
rails db:migrate
rails db:seed
rails s
```
### Run tests
To run tests, run the following command:
```sh
rails db:migrate RAILS_ENV=test
rspec spec/model/
```
- [Kanban board](https://github.com/rubydevi/jetlogix-backend/projects/1)
- [Kanban board initial state ](https://user-images.githubusercontent.com/112550568/279359779-a877a136-d14e-4813-8868-68b5b7aec9e6.png)
- We are a team of 3 members as indicated in the authors section
๐ค Chongtham Ruby Devi
- GitHub: [@rubydevi](https://github.com/rubydevi)
- LinkedIn: [@Chongtham Ruby Devi](https://www.linkedin.com/in/chongtham-bhoomika/)
๐ค Yonas Henok
- GitHub: [@YonasHenok](https://github.com/Yonashenok)
- Twitter: [@YonasHenok3](https://www.twitter.com/YonasHenok3)
- LinkedIn: [@Yonas Henok](https://www.linkedin.com/in/yonas-henok/)
๐ค Riley Manda
- GitHub: [@RileyManda](https://github.com/RileyManda)
- Twitter: [@rilecodez](https://twitter.com/rileycodez)
- LinkedIn: [rileymanda](https://www.linkedin.com/in/rileymanda/)
> Video Presentation demo of the project
> Deploy the application on render
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/rubydevi/jetlogix-backend/issues).
Thank you for taking the time to explore this project! Your support means a lot to me. If you find my project valuable and would like to contribute, here is one way you can support me:
- Star the project โญ๏ธ: Show your appreciation by starring this GitHub repository. It helps increase visibility and lets others know that the project is well-received.
- Fork the project ๐ด ๐ฃ: If you're interested in making improvements or adding new features, feel free to fork the project. You can work on your own version and even submit pull requests to suggest changes.
- Share with others ๐บ๏ธ: Spread the word about this project. Share it on social media, mention it in relevant forums or communities, or recommend it to colleagues and friends who might find it useful.
We would like to express my sincere gratitude to [Microverse](https://github.com/microverseinc), the dedicated reviewers, and collaborators. Your unwavering support, feedback, and collaborative efforts have played an immense role in making this journey a resounding success.
A big thank you to [Murat Korkmaz](https://www.behance.net/muratk) for the providing the UX design inspiration for this project.
- **Question_1**
Do I have to use the vs code specifically?
- Answer_1
You can use any one of your favortite or prefered editors
- This application's front-end UI design is based on the original design by: [Murat Korkmaz](https://www.behance.net/muratk)
[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](./LICENSE)