marcooquendoc/laptop-station-backend

Rails Backend for the Laptop Station app. This is a "Book an Appointment" app

Laptop Station Backend

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 👷🏼 Frontend link
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Laptop Station Backend

Laptop Station Backend holds the BackEnd development source rails api of the Laptop Station app which is a "Book an Appointment" type app.

🛠 Built With

Tech Stack

Client

• Ruby

Server

• Rails

Database

• PostgreSQL

Entity Relationship Diagram (ERD)

• 

Key Features

• [Devise authentication to access Reservations]
• [JWT Authorization upon login and register]
• [Rspec Unit testing]

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

🚀 Link to Frontend

• Laptop-Station-Frontend

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

In order to work on this project, you need to have the following dependencies installed:

• Ruby
• Postgresql
• Node.js
• Rails

Setup

• Clone the projects
• In the backend. Create a file called .env in your root directory with the following content:

  DB_USERNAME = postgres
  DB_HOST = localhost
  DB_PASSWORD = HERE-GOES-YOUR-PG-ADMIN-PASSWORD
  DB_PORT = 5432
  
  SECRET_KEY_BASE = fc5fba45f7f2d5de9fcfee8a6b35bdfeaf296661c69d05ed73a71347c447e5d46c2785d581c5f241fee3467a9b73ca784d085727abfe68d9a81b5b9441f08cf9

• The file database.yml is already configured to use those variables, you could check in Linux terminal the postgres databases using sudo -i -u postgres then psql.

Install

Install this project with:

  cd my-project
  bundle install
  rails db:create
  rails db:migrate
  rails db:seed

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

  rspec
  rake rswag

Deployment

You can deploy this project in the browser opening the page:

  localhost:3001

(back to top)

👥 Authors

Mention all of the collaborators of this project.

Josué Benavides

• GitHub: @jdbs9514
• Twitter: @JODA1015
• LinkedIn: Josué

Marco Oquendo

• GitHub: @MarcoOquendoC.
• Twitter: @marcooquendoc.
• LinkedIn: Marco Vinicio Oquendo.

Marcos Gualtero Lourenzo

• GitHub: @Goruchie
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

Mauricio Mendoza

• GitHub: @rbreva
• Twitter: @rbreva75
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

Describe 1 - 3 features you will add to the project.

• [Confirmation after sign up]
• [Deploy using Render]
• [Admin Access]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project please give us a Star

(back to top)

🙏 Acknowledgments

I would like to thank:

• Microverse
• Code Reviewers

(back to top)

📝 License

This project is MIT licensed.

(back to top)

laptop-station-backend's Issues

[2pt] - Add Unit Tests - Laptops

Laptops:

Model

[2pt] Implement Admin Role

• Add Admin user
• Allow Admin to modify all data
• Limit access to other users

[2pt] Add full documentation for the API

Use RSwag to generate Swagger documentation

• Add gem 'rswag-api'
• Complete API documentation.
• Add documentation to the readme file.

[4pt] Authentication and Authorizations

• Setup Devise Gem (gem 'devise', '~> 4.9')
• Follow the instructions:
  https://github.com/heartcombo/devise
• Configure controllers
• Update routes
• Setup authorizations and routes
  • Login
  • Logout
  • Sign up

[2pt] - Data cleanup

• Update the image links for each laptop in the seed file.
• Check that each image link works correctly.

[2pt] Add controllers

• Update Users controller
• Update Reservations controller
• Update Laptops controller
• Update routes

[2pt] Add Models

• Generate Laptop Model
• Add associations/relationships
• Add Validations

[3pt] Setup Github Repository

• Create rails API
• Setup repository
• Create Kanban board
• Setup gitflow

[2pt] - Add Unit Tests - Users

Users:

Model

[2pt] Setup linters

• Add Rubocop gem
• Setup Github workflows

[2pt] - Add Unit Tests - Reservations

Reservations:

Model

[2pt] N + 1

• Resolve n+1 problem

[1pt] Correct routes and Readme

• Correct the .env file information.
• Update Routes

[1pt] Database configuration

• Add gem 'dotenv-rails'
• PostgreSQL configuration
• Create database

[2pt] Update Readme

• Create a professional Readme file
• Add License
• Add Creative Commons link

[2pt] Setup testing libraries

• Add rspec-rails gem