Vibely

This web app tries to bring together bands and establishments that wants to make an event of music

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

You will need to have installed docker and docker-compose. To know if this is working properly use docker run hello-world and docker-compose --version. To get them installed properly at your OS, refer to the oficial pages of docker and use:

python3 -m pip install docker-compose

Installing

Copy '.env.example' to file named '.env'. Then change the variable DJANGO_SECRET_KEY=[key] to a value generated. For example, using this site.

So the contents of .env should be:

#Django configuration 

OPEN_PORT=8000
DJANGO_PORT=8000

DJANGO_SECRET_KEY=<your secret key goes here>
DJANGO_DEBUG=1
DJANGO_ALLOWED_HOSTS=localhost 127.0.0.1 [::1] 0.0.0.0

POSTGRES_USER=postgres
POSTGRES_PASSWORD=postgres
POSTGRES_HOST=db
POSTGRES_PORT=5432
POSTGRES_NAME=postgres

DATABASE_URL=postgres://postgres:postgres@db:5432/postgres
#DATABASE_URL=postgres://USER:PASSWORD@HOST:PORT/NAME

Then apply the changes to you database using:

docker-compose exec web python3 manage.py makemigrations
docker-compose exec web python3 manage.py migrate

To create a super user, use: docker-compose exec web python3 manage.py createsuperuser

Then use docker-compose up -d to get it running. Connect to localhost:8000/admin to see the admin login page

To stop it, use docker-compose down

Running the tests

To execute all tests, use docker-compose exec web python3 manage.py test apps

Test Structure

Tests are in these format:

apps
  | ...
  | tests
    | __init__.py
    | test_<something>.py

So we ensure that all tests are discovered and tests are separated for diferent functionalities, as models, views or templates.

Test names

All tests must be using a class derived from TestCase (or derived from it). Also, all methods that test must begin with test, so manage.py does properly discover them.

Deployment

Master branch is deployed in CI/CD at this site

Built With

• Django - The web framework used.
• Docker - Container management.
• Heroku - Cloud Application Platform.
• PostgreSQL - Open Source Database.
• Travis - Test CI.
• Crispy forms - For more crispy forms.
• Bootstrap 4 - A pretty css.

Authors

• Pau Ibáñez Millán
• Joan Martí Olivart
• Ian Palacín Aliana
• Joaquim Picó Mora
• Sergi Simón Balcells

License

This project is licensed under the GPLv3 License - see the LICENSE file for details