Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rogermedico/nrs-theater-app


https://github.com/rogermedico/nrs-theater-app

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README 

        
# Advanced PHP Test for the NRS Group



## Context



I was provided with instructions to build a theater tickets management app

with the following conditions:



 - Laravel has to be used as an MVC framework

 - GIT has to be used as a code repository

 - Bootstrap has to be used as a styling library

 - The data has to be stored in a MySQL database

 - Every time a reservation is made a log entry has to be made

 - The users and reservations data has to be stored as a non-volatile info

 - Each reservation can have one or more seats

 - Each seat has to have a row and a column

 - The user cannot pick an already reserved seat



Improvements to be taken into consideration besides these conditions will be:

 - Complete CRUD for reservations and users

 - Code organization

 - Error check

 - Containerized application



## Project behaviour



### Users



The users can register, login and logout using the links provided in the toolbar.

Guest users have to fill extra fields when making a reservation to register automatically

in the app. When a user is logged in, he can access a profile page which allows him to

edit his personal data, password or even delete his account.



User creation don't send verification emails for simplicity, but it checks for email uniqueness.



At the very beginning, the app has 7 users already registered. One admin and 6 normal users.

The credentials for the two types of users are the following:



| Username        | Password |

|-----------------|----------|

| [email protected] | password |

| [email protected]  | password |



The admin user can access a special section under the admin menu dropdown to modify other user info.



When a user registers himself to the app he is automatically logged in.



### Reservations



The reservations are made in two steps. In the first step, the user selects the session that

he wants to book (if it's a guest he has to fill in the fields to register)

and then, the user can select as many seats as he wants.



When a user has made a reservation, a menu link appears to manage his own reservations.

Through that menu, he can access a CRUD that allows him to modify or delete his reservations.

The admin user, through the corresponding menu link, can manage all other user reservations.



The guest user is automatically logged in when he makes a reservation filling in all the fields.



### Sessions



In the beginning there are 6 sessions already created in the app, but the admin user can create, 

modify or delete as he pleases using the CRUD in the manage sessions page accessible through

the admin menu.



## About the project 



### DB



The DB schema consists of three tables. One with users info, another with

sessions and the last one with the reservations.



The users table stores the users info such as name, surname, email, password and

if the user is an admin. The sessions table stores info about the sessions that will take place

in the theater with the fields name, date and price. Finally, the reservations table

stores information about every reservation with the user that made it, the session

for which the reservation is made, and the row and the column of the reserved seat.



The DB configuration is made using migrations and, initially, is filled

with some information provided by the seeders and the factories.



### Routes



Routes are basically three resources, one for each entity in the project (session, user and reservation)

and some complementary routes. Every route has its middleware applied to avoid forbidden access.

The middlewares that have been used are auth, guest and a new created one called admin that checks if a user is an admin.



### Models



There are three models, again, one for each entity. The relations between them are specified in each model

and in the user model there is also a mutator for the password.



## Controllers



As expected there are three controllers. The controllers use policies and gates to 

check that the users can perform the actions. It is best practice to add middleware in the

routes file. However, in the user and the reservation controllers, there are middlewares applied in 

the constructor, because different methods of the resource have to have different middlewares.



The validation of the fields is always made using custom requests, as it is expected from a well-done project.



## Run Project (local environment)

All steps tested on Ubuntu.

### Needed commands



Check that you have make, docker and docker-compose installed on your system running the following commands:

- make -v

- docker -v

- docker-compose -v



### Set up steps



1. Download or clone the code in this repository

2. Execute ``make build`` to build docker containers

3. Execute ``make run`` to actually run the containers

4. Execute ``make prepare`` to prepare the app for the first run. This command imports composer and npm dependencies, generates .env file, generates app key, establishes symbolic link between storage and public directory, migrates the DB and generates compiled css and js files.



### Acces the app



If all the setup steps gone well the url to acces the app is [localhost:8080](http://localhost:8080) and the url to access the data base (phpMyAdmin) is [localhost:8081](http://localhost:8081) (user: root, password: password).



## Stop Project



To stop the project containers just run the command

``make stop`` or if you want to remove all stopped containers and networks run ``make down``.



## Tests



To run the tests you have to execute the following command ``make test``.

Due to the lack of time, only the user tests have been made.



## TO DO



 - Extract some controller functionality to a service

 - Reservation and session tests

 - Find a more meaningful word for "session" (maybe show/event) and refactor all the code with the better found word



## Author



Roger Medico Piqué - [[email protected]](mailto:[email protected])