Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/v-blaze/gvash-planes-api
GVASH PLANES is a rails API Web-App where users can browse list of planes and make reservations on a plane for a given duration.
https://github.com/v-blaze/gvash-planes-api
api database jwt-authentication postgresql rails rails-api rspec ruby-on-rails
Last synced: about 2 months ago
JSON representation
GVASH PLANES is a rails API Web-App where users can browse list of planes and make reservations on a plane for a given duration.
- Host: GitHub
- URL: https://github.com/v-blaze/gvash-planes-api
- Owner: V-Blaze
- License: mit
- Created: 2023-03-29T13:33:59.000Z (almost 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-04-14T08:36:43.000Z (almost 2 years ago)
- Last Synced: 2024-10-27T17:08:22.625Z (3 months ago)
- Topics: api, database, jwt-authentication, postgresql, rails, rails-api, rspec, ruby-on-rails
- Language: Ruby
- Homepage: https://gvash-planes.vercel.app/
- Size: 266 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
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)
- [Kanban Board](#kanban-board)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)
> GVASH PLANES is a rails application where you can book planes. This app is created using `Rails` as an api and `React` as frontend with 5 people.
## 🛠 Project Links
- [Frontend Repository](https://github.com/V-Blaze/gvash-planes)
- [Backend Repository](https://github.com/V-Blaze/GVASH-PLANES-API)
REACT
Server
Database
- A user can register and log in, so that the data is private to them.
- Book new planes
- Create planes (only for admin)
- [Kanban-Board](https://github.com/users/V-Blaze/projects/4/views/1?layout=board)
- [Kanban-Board initial screenshot](https://user-images.githubusercontent.com/29674658/228588538-cdaa7ccd-9f87-49f8-b60c-266db3183e60.png)
- At the end of this project, we are still 5 members: @Samuellekpor, @ginabeki, @Abdessittir, @heintayzar-hm, and @V-Blaze.
- [Frontend Deployed Link](https://gvash-planes.vercel.app/)
- [Backend Deployed Link](https://gvash-planes.onrender.com/)
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
```sh
gem install
```
### Setup
Clone this repository to your desired folder(`Rails`):
```sh
git clone https://github.com/V-Blaze/GVASH-PLANES-API.git
```
Clone Another repository for frontend(`React`). [Project](https://github.com/V-Blaze/gvash-planes)
```sh
git clone https://github.com/V-Blaze/gvash-planes.git
```
### Install
Install Rails Project with:
```sh
cd GVASH-PLANES-API
bundle install
```
```
Setup database credentials
config/database.yml
```
```sh
rails db:setup
rails s
```
For the React project,
- Go to the respective folder where you clone.
- At the root folder of your app, Make new file called `.env` and add the following.
```sh
REACT_APP_API_URL=http://127.0.0.1:3000
```
- Run the following.
```
npm install
npm start
```
### Authentication
if you wanna login as admin, you have to use the following credientials, please make sure to run above commands
```sh
email: [email protected]
password: password
```
### Run tests
To run tests, run the following command:
```
rspec spec --format documentation
```
👤 **Hein Tay Zar**
- GitHub: [@Hein Tay](https://github.com/heintayzar-hm)
- Twitter: [@Hein Tay](https://twitter.com/heintayzarhm)
- LinkedIn: [Hein Tay](https://www.linkedin.com/in/hein-tay-zar)
👤 **Valentine Blaze**
- GitHub: [@V-blaze](https://github.com/V-Blaze)
- Twitter: [@blaze_valentine](https://twitter.com/blaze_valentine)
- LinkedIn: [@valentine-blaze](https://www.linkedin.com/in/valentine-blaze/)
👤 **Gina Beki**
- GitHub: [@ginabeki](https://github.com/ginabeki)
- Twitter: [@gina](https://twitter.com/ginabeki)
- LinkedIn: [@ginabeki](https://www.linkedin.com/in/ginabeki/)
👤 **Abdessittir**
- GitHub: [@Abdessittir](https://github.com/Abdessittir)
- Twitter: [@AbdessittirHar1](https://twitter.com/AbdessittirHar1)
- LinkedIn: [Abdessittir Harkati](https://www.linkedin.com/in/abdessittir-harkati-a61b7324a/)
👤 **Sammuel LEKPOR**
- GitHub: [@gSamuellekpor](https://github.com/Samuellekpor)
- Twitter: [@samuel_lekpor](https://twitter.com/samuel_lekpor)
- LinkedIn: [sammuel_kepor](https://linkedin.com/in/sammuel-lekpor)
- Fully Functional Auth Pages including email verifications and forgot password pages
- Make multiple admins
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project, Please give it a ⭐️
Thanks [@Murat Korkmaz on Behance.](https://www.behance.net/muratk) for providing [this template](https://www.behance.net/gallery/26425031/Vespa-Responsive-Redesign)
Thanks microvers for giving this oppournity.
This project is [MIT](./LICENSE) licensed.