https://github.com/tkz96/jet-log-backend
The backend that powers the Jet Log project. This is where all the logic operates and the data is served from. Built with Ruby on Rails and PostgreSQL.
https://github.com/tkz96/jet-log-backend
heroku postgresql ruby-on-rails
Last synced: about 1 year ago
JSON representation
The backend that powers the Jet Log project. This is where all the logic operates and the data is served from. Built with Ruby on Rails and PostgreSQL.
- Host: GitHub
- URL: https://github.com/tkz96/jet-log-backend
- Owner: tkz96
- License: other
- Created: 2022-12-01T15:16:26.000Z (over 3 years ago)
- Default Branch: dev
- Last Pushed: 2022-12-16T08:39:14.000Z (over 3 years ago)
- Last Synced: 2025-01-09T19:12:26.570Z (over 1 year ago)
- Topics: heroku, postgresql, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 641 KB
- Stars: 3
- Watchers: 1
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
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)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [Kanban](#kanban)
- [👥 Authors](#authors)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
**Jet-Log-BackEnd** is a backend api used by [jet-log-frontend](https://github.com/tkz96/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
Technologies
Database
- **[Authentication-API]**
- **[Aeroplanes-API]**
- **[Reservations-API]**
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](https://github.com/tkz96/jet-log-frontend.git)
- 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
```
### Deployment
- The project has been delpoyed at [https://jet-log.herokuapp.com](https://jet-log.herokuapp.com)
### Kanban
- This is the link to the [Kanban Board](https://github.com/users/tkz96/projects/2/views/3)
- This is the link to the [Kanban Board screenshots](https://docs.google.com/document/d/1925OavHmfyYMGpLE-CxJED_-M3QUzuIUvk3eENh0pu0/edit?usp=sharing)
- Our team had 5 members
👤 **Talha Zuberi**
- GitHub: [@tkz96](https://github.com/tkz96)
- Twitter: [@tkz96](https://twitter.com/tkz96)
- LinkedIn: [Talha Zuberi](https://www.linkedin.com/in/talha-zuberi/)
👤 **Bengi Genç**
- GitHub: [@bengigo](https://github.com/bengigo)
- Twitter: [@bengigo](https://twitter.com/bengi_gb)
- LinkedIn: [Bengi](https://www.linkedin.com/in/bengigenc/)
👤 **Sharon Odhiambo**
- GitHub: [@sharon-odhiambo](https://github.com/sharon-odhiambo)
- Twitter: [@SharonVictor16](https://twitter.com/sharonvictor16)
- LinkedIn: [Sharon Odhiambo](https://www.linkedin.com/in/sharonn-odhiambo/)
👤 **Aquinas Moriasi**
- GitHub: [Aquinas Moriasi](https://github.com/Aquinasmoriasi)
- Twitter: [@Aquinas747](https://twitter.com/Aquinas747)
- LinkedIn: [Aquinas Moriasi](https://twitter.com/aquinas-moriasi)
👤 **Berkay Akbas**
- GitHub: [@berkay-akbas](https://github.com/Berkay-akbas)
- LinkedIn: [Berkay Akbas](https://www.linkedin.com/in/berkay-akbas-a03b3b239/)
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project, please give it a ⭐ at [jetlog-backend](https://github.com/tkz96/jet-log-backend) and [jetlog-frontend](https://github.com/tkz96/jet-log-frontend)
- Original design by [Murat Korkmaz on Behance](https://www.behance.net/muratk).
This project is [MIT](./LICENSE) licensed.