cancelei/esportgamingcenter_backend

This repo is part of the Microverse Programming Remote School.

Esport Gaming Center

📗 Table of Contents

• 📗 Table of Contents
• 📖🚗 Esport Gaming Center App
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 🎫 Kanban Board
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ
  • 📝 License

📖🚗 Esport Gaming Center App

This project involves developing an eSports reservation system with two distinct parts: the Backend, developed using Ruby on Rails, and the Frontend, built with React. This system aims to cater to eSports players, allowing them to reserve games, manage reservations, and access a catalog of available games. Click on the link[https://github.com/cancelei/EsportGamingCenter_frontend] to navigate to the backend of our APP.

🛠 Built With

Tech Stack

List of technologies used for this project

BackEnd

• Ruby on Rails
• Stimulus
• Rspec

Front-end/View

• React
• Axios
• Tailwind CSS

Front-end/Store management

• React-redux

Database

• PostgreSQL

Key Features

• Create and Remove Games
• Create Reservations
• Full stack webpage
• Can see all the list of reservation of current user
• Details of every game in db
• Log in and Sign up feature

(back to top)

🚀 Live Demo

Under Construction 💻📲

(back to top)

🎫 Kanban Board

• Link to Kanban Board.
• Initial state of the Kanban Board.
• We are 5 members in our Team.

(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:

you need to install ruby 3.2.2 using the prefer tool, example:

• rvm

• rbenv

• asdf-vm

• Browser (Google Chrome, Mozilla Firefox, Safari or any other browser)

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/cancelei/EsportGamingCenter_backend.git

Install

Install this project with:

  cd EsportGamingCenter_backend
  bundle install
  npm install

Usage

To run the project, execute the following command:

./bin/dev

Note: If there are any errors consider adding your necesary username and password in database.yml for setting up your local enviroment and use the following comand:

rails db:drop db:create db:migrate
./bin/dev

Then, you have to create in the root of the project a .env file:

, inside of that file, you must put the following code:

DB_USER = 'postgress_database_user' Note: this it has to be as string ''
DB_PSW = 'postgress_database_user_password' Note: this it has to be as string ''
DB_PORT = your_postgress_port Note: this it has to be as an integer
DB_NAME_DEV = 'name_of_your_DB' Note: this it has to be as string ''
DB_NAME_TEST ='name_of_your_DB_test' Note: this it has to be as string ''

Example:

DB_USER = 'luis'
DB_PSW = 'luis123'
DB_PORT = 5432
DB_NAME_DEV = 'gaming'
DB_NAME_TEST ='gaming_test'

Run tests

To run tests, run the following command:

rake rswag:specs:swaggerize

(back to top)

👥 Authors

👨🏼‍🚀 Juan Diego Guerra (JD) 👽

• GitHub: @JuanDiegoGuerra
• Twitter: @jdxelric147
• LinkedIn: Juan Guerra

👤 Gardimy Charles 🐱‍👤

• GitHub: @Gardimy
• Twitter: @gardyelontiga45
• LinkedIn: Gardimy charles

👤 Luis Emilio Rojas Rojas

• GitHub
• Twitter
• LinkedIn

👨🏼‍🚀 Abel Lavieri 🧙🏼‍♂️

• GitHub
• Twitter
• LinkedIn

👨🏼‍🚀 Glauber Bannwart 🦸🏼‍♂️

• GitHub: @cancelei

(back to top)

🔭 Future Features

• Improve UI
• Add more functionalities
• Add more details on reservation list

(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 it a ⭐️!

(back to top)

🙏 Acknowledgments

We would like to thank Microverse for giving us the opportunity to learn and grow as developers and also We like to thank our family, they are all our support. 🌟

Original design idea by Murat Korkmaz on Behance.

(back to top)

❓ FAQ

• Do I need to install any program before running this project?

  • Yes, you need to install Ruby
  
  

• Can I use this project for my own purposes?

  • Yes, you can.

(back to top)

📝 License

This project is MIT licensed.

(back to top)

esportgamingcenter_backend's Issues

[2pt] Individual Task - Reserve from Navigation.

• When a user clicks the Reserve (in the nav bar) he should be prompted to the form where just his email is already selected (hardcoded).
• Form fields: email, Game, Setup_config, and Date (MM/DD/YYYY).
• The user should be able to select all available games from the list.
• The expected result is that a new Reservation appears in the Reservations List.

[2pt] Group Task #1 - Initialize Code in the Repository and Readme Preparation (Front and Backend)

Run Initialization commands in Front and backend.

• Front: Run the npx create-react app or similar.

• Backend: Run rails new app-name -pg –api

• Add 2 Readme File that need to be connected with each other and there should be a “main” readme file where we will put the deployment link (We chose to be the Backend Repo).

Navbar in game details and reservations

[2pt] Individual Task - Navigation Panel

You will develop a nav bar reviewing all of the already implemented routes, and create links to redirect users to the different views available.

• Includes links to:
  • Game Catalog (carrousel)
  • Games List (list for Admins to add and delete)
  • Reserve (form)
  • Reservations (list)
  • Sign Out

Add a button in the reservation page

Add the button when there are no reservations from the user.

Linter errors

[2pt] Group Task #5 - API Documentation

• Comprehensive documentation for the API should be provided.

[2pt] Group Task #2 - Responsive Design

The application should be responsive, with both mobile and desktop versions efficiently designed.

[2pt] Individual Task - Implement Restriction for Admin-Exclusive Access

• Ensure that the ‘Game List’ view and methods 'Add Game' and 'Delete Game' are accessible only to users with admin privileges.
• Validate if a User can delete his own reservations.
• Validate if a User can create his own reservations.
• Validate if the user and the admin have different permissions related to adding and deleting games. Important: A user shouldn’t be able to delete or add a new Game to the Catalog.

[2pt] Individual Task - API connection with External Esports data provider

This is an optional task.
If it is solved, the main purpose is to use an external API just for the games images.

[2pt] Individual Task - Reserve from Detail Page

• When a user goes to the ‘Game Detail Page’ and clicks on the Reserve Button, he should be prompted to the form where his email and the selected game are “hardcoded” on the form.
• The expected result is that a new Reservation appear in the Reservations List.

[1pt] Group Task #0 - Setup Kanban Board

• In this milestone we have setted up the Kanban Board and assigned all the task to the respective team member.
• Project : Kanban Board

Group of 5: ( @JuanDiegoGuerra @alvp01 @cancelei @Gardimy @lerfast ) 👨🏼‍🚀

Filter reservations per user

[2pt] Individual Task - Adding New Game

• A form is accessible via the navigation panel for adding new games to the catalog.
• After adding an item with complete information needed according to the data base schema shared on 11/29/2023. The new Game should appear in the Catalog of Games.
• This task will have code implementation on the controller, model and view.
• An added game should appear in the Catalog Page and the Game List page.

Clean the code in front end

Delete unnecessary comments and console logs.

[2pt] Group Task #6 - User Authentication and Login

• Users log in via a simple interface, inputting only their username. The user table should have Full Name, email and let Devise gem create the remaining user table-related information.

• Expected result after filling in the ‘Sign In’ form, the user should be redirected to the Catalog Page.

[2pt] Individual Task - Game Detail Page

• Features a full description of the selected game.
• Includes a 'Reserve' button to book the game.
• This task will have code implementation on the controller, model, and view.
• Use each game in the catalog as link to the correct Detail Page for that Game.

Fix carrousel size issues

[1pt] Group Task #3 - Fix Linter Issues

Each person will fix linter errors of their respective tasks when this task is started.

Optional:

• Unit Test (Models, Controllers and Views)
• Integration Test (For user interactions)

[2pt] Individual Task - Games List

• Create a list of all games that are available. For now, just the basic structure is needed.
• It should make all the games that are available in the Catalog appear here in List format, so in future tasks, we will transform it into an “Admin-related feature”.

[2pt] Individual Task - Deletion of Games

• When navigating in the Games List with all games each row will have an add a 'Delete' button.
• This task will have code implementation on the controller, model and view.
• Expected Result: A deleted game should disappear from the Catalog Page and the Game List page.

[2pt] Individual Task - Game Catalog

• You will create a carousel that displays a Catalog of all Games available. (With name, short details, and genre).
• Displays a carousel view of available games.

[1pt] Group Task #4 - Create schema.sql and database diagram

Create schema.sql and database diagram

Seeds (admin users and games)

[2pt] Individual Task - My Reservations Page

Users can view all their reservations, with details like game name, date, and config_PC.