Game-Management

Description

Django web application to manage a history of games played. This project is part of Web Project subject on UdL.

Installation

Manual installation of the project:

1. Clone the repository

git clone https://github.com/Computer-Engineering-UdL/Game-Management.git

2. Navigate to the project folder

cd Game-Management

3. Install the required packages using Poetry

• Option 1: In case you want to develop the project, you can install the development dependencies by running the following command:

  poetry install

  Remember to activate the virtual environment by running the following command:

  poetry shell

Note

For more information check the CONTRIBUTING file.

• Option 2: In case you want to run the project, you can install the production dependencies by running the following command:

  poetry install --no-dev

Deploy

Local deployment

1. Access the virtual environment

poetry shell

2. Run the application

python manage.py runserver

Also, you can apply the following commands to generate and apply the database migrations

python manage.py makemigrations
python manage.py migrate

Docker deployment

1. Build and run the containers

docker-compose up

2. Open a new terminal, and access the desired container

docker exec -it <container_name> || <container_id> bash

If the app container is accessed you apply the following command to start managing the migrations and orchestrating the app:

poetry shell

Otherwise, if the db container is accessed, we can do database administration tasks. A good way to directly access the database is:

docker exec -it <db_container_name> || <db_container_id> psql -U admin -d app_db

For both, when the app is running, open your browser and go to the localhost url.

Important

If any dependency exception occurs it's probably because you have to run

poetry lock

poetry install

Warning

Only in production branch PostgreSQL is used as database, in the main branch SQLite is used.

Matrix of responsibilities

In order to organize the work, we have divided the project into different sectors and assigned people to each of them.

Sector	People involved
Frontend	Abel, Carles, Oriol
Backend	Aniol, Aleix, Júlia
Testing	Aniol, Abel & Júlia
Database	Aleix & Aniol
Project Management	Aniol
Deployment	Aleix & Aniol

Contributing

To contribute to this project go to the CONTRIBUTING file.

Documentation

The documentation of the project is available in the Documentation folder.

Licence

This project is under MIT Licence - see the LICENCE file for details.

Authors

The Web Project team is composed by:

• Nogales López, Júlia
• Pérez Salvia, Abel
• Segura Paz, Aleix
• Serrano Ortega, Aniol
• Soldevila Solsona, Oriol
• Sànchez Hidalgo, Carles