mwafrika/final_capstone_backend

activestorage github jsonwebtoken postgresql postman rails ruby

Explore the API docs »

View Demo · Report Bug · Request Feature

TABLE OF CONTENTS

About The Project
- ERD diagram
- Built With
Getting Started
- Prerequisites
- Installation
Usage
Kanban board
Contributing
Authors
Acknowledgments
License

About The Project

Yamaha Motor App is a motorcycle reservation platform that allows customers to book their motorcycle remotely within a defined time frame.

ERD diagram

Built With

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

POSTGRESQL ~> 14.x
Ruby ~> 3.1.x

Installation

Clone the repo:

git clone git@github.com:mwafrika/final_capstone_backend.git

go to the project folder:
```
cd final_capstone_backend
```
Install the dependencies:
```
bundle install
```
Set the following the environment variables for database:
```
DATABASE_NAME
USER_PASSWORD
USER_NAME
```
Create database:
```
rails db:create
```
Run the migrations:
```
rails db:migrate
```
Seed the database:
```
rails db:seed
```
Generate a secret key:
```
 rails secret
```
Edit your credentials.yml.enc file:

$env:EDITOR="notepad"

rails credentials:edit

Set the credentials to decode the JWT

secret_key_base: <your secret key>

Launch the server:

rails s -p 8000

⬆️

Usage

For more Info on how to use the API, please refer to the Yamaha motor API Documentation

Kanban board

👉 Kanban board link

👉 This project was authored by Four contributors as described in the the Authors section bellow.

👉 Please use this link to go to the front-end part of this project.

⬆️

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

Please, take a look at open issues for a full list of proposed features (and known issues).

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Don't forget to give the project a star! Thanks again!