Skip to content

Commit

Permalink
Added attribution,kanban board states to readme|env file setup|added …
Browse files Browse the repository at this point in the history
…fe link section
  • Loading branch information
RileyManda committed Nov 13, 2023
1 parent e42cab2 commit cfd14fa
Show file tree
Hide file tree
Showing 3 changed files with 196 additions and 30 deletions.
67 changes: 37 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,20 @@
# 📗 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)
- [🚀 Presentation](#video-presentation)
- [💻 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)
Expand All @@ -37,7 +39,13 @@

# 📖 [JetLogix] <a name="about-project"></a>

JetLogix’s backend is a robust Rails application utilizing PostgreSQL database, managing private jet reservations. It exposes efficient API endpoints to [JetLogix front end](https://github.com/rubydevi/jetlogix-frontend), providing access to the application’s database and ensuring secure storage and retrieval private jets, user's, and reservation data.
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.



## 🚀 FrontEnd <a name="front-end"></a>

[Click here to see the JetLogix front end](https://github.com/rubydevi/jetlogix-frontend)

## 🛠 Built With <a name="built-with"></a>

Expand Down Expand Up @@ -79,19 +87,6 @@ JetLogix’s backend is a robust Rails application utilizing PostgreSQL database
<li><a href="https://github.com/rswag/rswag">Rswag</a></li>
</ul>

<!--
<summary>Rubocop</summary>
<ul>
<li><a href="https://github.com/rubocop/rubocop-rails">Rubocop</a></li>
</ul>
<summary>Selenium Web driver</summary>
<ul>
<li><a href="https://rubygems.org/gems/selenium-webdriver/versions/4.4.0">Selenium Web driver</a></li>
</ul> -->

<!-- Features -->

### Key Features <a name="key-features"></a>
Expand All @@ -109,17 +104,6 @@ JetLogix’s backend is a robust Rails application utilizing PostgreSQL database
<!--
## 🚀 Live Demo <a name="live-demo"></a>
> Live Demo of this application:
- [Live Demo Link](https:// )
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## 🚀 Video Presentation Demo <a name="video-presentation"></a>
> Video Presentation of this application:
- [Video Presentation]( ) -->
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
Expand Down Expand Up @@ -150,7 +134,21 @@ Install this project with:

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: jetlogix_backend_production
username: jetlogix_backend
password: <%= ENV["JETLOGIX_BACKEND_DATABASE_PASSWORD"] %>
```

### Usage
Expand Down Expand Up @@ -191,6 +189,14 @@ Example:

<p align="right">(<a href="#readme-top">back to top</a>)</p>

## 📆 Kanban Board <a name="kanban-board"></a>

- [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)

<!-- CONTRIBUTING -->

<!-- AUTHORS -->

## 👥 Authors <a name="authors"></a>
Expand Down Expand Up @@ -224,7 +230,7 @@ Example:
<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- CONTRIBUTING -->
<!-- Kanban Board -->

## 🤝 Contributing <a name="contributing"></a>

Expand Down Expand Up @@ -254,7 +260,8 @@ Thank you for taking the time to explore this project! Your support means a lot

## 🙏 Acknowledgments <a name="acknowledgements"></a>

I 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. I am truly grateful for your contributions and for being an integral part of my achievements. Thank you for your continued support.
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.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Expand All @@ -273,8 +280,8 @@ I would like to express my sincere gratitude to [Microverse](https://github.com/
<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- ATTRIBUTION -->
<!-- ## 👥 Attribution <a name="attribution"></a>
- ProjectIcon: [Svgrepo](https://www.svgrepo.com/) -->
## 👥 Attribution <a name="attribution"></a>
- This application's front-end UI design is based on the original design by: [Murat Korkmaz](https://www.behance.net/muratk)

<!-- LICENSE -->

Expand Down
1 change: 1 addition & 0 deletions config/credentials.yml.enc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
VB3sNFERqzX4uqWwCzAUvhh9gn32ynd3z5Z53TRusG8/if9tTfo5bFW6peQstMJ2biYuMridqcn4wyhl+3rX9TVgr3lmWDSvbRkIBeEcI2vscAb61eRPps44a0IzDLtbP0ok+9ECgAw+LfBKpeoKXymmmPGkjDOc1nfjZwxKsYj79/yC6UiZfODVbPQ0bv/qxq67rDoZorDl2KPt48HnWuUuMoG+8LwISi9Oad+e8Z5ZrDu+93nIRu0706wqffx11xrIRzqTjQm5+KwHX/y25N2PxwK9Bde27Kz5NuQURxm1yDfEZJJA08aPVXan6IxmlEDhmWFcarm9nRQUtr6keiz/EgyPE71F99cG4y5xahENVEeFBtc4bRAEo2O6TEpiaCsfe926xaJLTT4wZXyYz3/Dwlo7--BEFaqjiMRqtcqRBZ--MzJAf8jUO34Crhq9BSx1iQ==
158 changes: 158 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit cfd14fa

Please sign in to comment.