Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme update #33

Merged
merged 6 commits into from
Nov 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 19 additions & 51 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@

</div>


<a name="readme-top"></a>

<!-- TABLE OF CONTENTS -->
Expand Down Expand Up @@ -34,76 +33,52 @@
- [❓ FAQ](#faq)
- [📝 License](#license)


<!-- PROJECT DESCRIPTION -->

# 📖 [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 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.

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

### Tech Stack <a name="tech-stack"></a>



<ul>
<li><a href="https://rubyonrails.org/">Rails</a></li>
</ul>



<ul>
<li><a href="https://www.ruby-lang.org/en/">Ruby</a></li>
</ul>




<ul>
<li><a href="https://www.mysql.com/">PSQL</a></li>
</ul>




<ul>
<li><a href="https://www.mysql.com/">RSpec-Rails</a></li>
</ul>




<ul>
<li><a href="https://teamcapybara.github.io/capybara/">Capybara-Rails</a></li>
</ul>




<ul>
<li><a href="https://github.com/CanCanCommunity/cancancan">Cancan</a></li>
</ul>




<ul>
<li><a href="https://github.com/heartcombo/devise">Devise</a></li>
</ul>


<ul>
<li><a href="https://github.com/ged/ruby-pg">Ruby Pg</a></li>
</ul>

<ul>
<ul>
<li><a href="https://github.com/rswag/rswag">Rswag</a></li>
</ul>



<!--
<summary>Rubocop</summary>
<ul>
Expand All @@ -117,8 +92,6 @@ JetLogix’s backend is a robust Rails application utilizing PostgreSQL database
<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 @@ -130,10 +103,10 @@ JetLogix’s backend is a robust Rails application utilizing PostgreSQL database
> Secure user authentication and profile management
> API documentation

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

<!-- LIVE DEMO -->

<!--
## 🚀 Live Demo <a name="live-demo"></a>

> Live Demo of this application:
Expand All @@ -146,7 +119,7 @@ JetLogix’s backend is a robust Rails application utilizing PostgreSQL database

> Video Presentation of this application:

- [Video Presentation]( )
- [Video Presentation]( ) -->

<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
Expand All @@ -163,42 +136,41 @@ In order to run this project you need:

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
```
```sh
cd my-project

bundle install


```

### Usage

To run the project, you will need to execute:


```sh
rails credentials:edit

rails s
```


### Run tests

To run tests, run the following command:


```sh
Rspec spec or bundle exec rspec spec
```


<!-- ### Deployment

You can deploy this project using: -->
Expand Down Expand Up @@ -234,19 +206,16 @@ Example:
- Twitter: [@rilecodez](https://twitter.com/rileycodez)
- LinkedIn: [rileymanda](https://www.linkedin.com/in/rileymanda/)


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

<!-- FUTURE FEATURES -->

## 🔭 Future Features <a name="future-features"></a>


> Video Presentation demo of the project

> Deploy the application on render


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

<!-- CONTRIBUTING -->
Expand All @@ -262,15 +231,16 @@ Feel free to check the [issues page](https://github.com/rubydevi/jetlogix-backen
<!-- SUPPORT -->

<!-- SUPPORT -->

## <b>Show your support 🌟</b><a name="support"></a>

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:

- <b>Star the project ⭐️</b>: Show your appreciation by starring this GitHub repository. It helps increase visibility and lets others know that the project is well-received.
- <b>Star the project ⭐️</b>: Show your appreciation by starring this GitHub repository. It helps increase visibility and lets others know that the project is well-received.

- <b>Fork the project 🍴 🎣</b>: 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.
- <b>Fork the project 🍴 🎣</b>: 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.

- <b>Share with others 🗺️</b>: 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.
- <b>Share with others 🗺️</b>: 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.

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

Expand All @@ -294,18 +264,16 @@ I would like to express my sincere gratitude to [Microverse](https://github.com/

You can use any one of your favortite or prefered editors<br>


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

<!-- ATTRIBUTION -->
<!-- ## 👥 Attribution <a name="attribution"></a>
- ProjectIcon: [Svgrepo](https://www.svgrepo.com/) -->


<!-- LICENSE -->

## 📝 License <a name="license"></a>

[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](./LICENSE)

<p align="right">(<a href="#readme-top">back to top</a>)</p>
<p align="right">(<a href="#readme-top">back to top</a>)</p>
1 change: 0 additions & 1 deletion config/credentials.yml.enc

This file was deleted.

Loading