Director

It’s Friday night. The party’s poppin’. Everything looks perfect - except Tom’s appointed himself the DJ. From every last remix of Old Town Road, to a salacious selection of death metal and mumble rap, Tom’s playlist is uniquely… his. Which is fine! But at a party, everyone should have a say in the music. Enter Director: a service to democratize party playlists, getting everyone involved in the musical extravaganza.

Director is a full-stack web app, designed to be the premiere destination for party playlists.

Prerequisites

• Docker 19.03.5+ & docker-compose 1.24.1+

Usage

1. From the root of the repo, run docker-compose build to build the docker containers.
2. To run them, use docker-compose up.
3. From there, http://localhost:8000 will link to the API, and http://localhost:3000 will link to the frontend.
4. Refer to docker-compose documentation for further options, such as running in detached mode.

Testing

• To test frontend components, run npm run test.
• To test backend components, run docker exec -it director_backend manage.py test.

Cleanup

1. To stop the containers:
   • If not detached: use Ctrl+C in the terminal window from which you ran docker-compose up
   • Whether detached or not: run docker-compose down.
2. To clean up the containers' associated volumes as well, run docker-compose down -v.
3. To do a full compose stack cleanup, destroying images, volumes and dangling stuff, run docker-compose down -v --rmi all --remove-orphans.
4. To completely clear everything Docker-related: docker system prune.
5. Consult the Docker documentation for further options beyond these.

Tech Stack Description

Director is built using Django and React. Django incorporates Django Channels, and the Django Rest Framework. React utilizes React Bootstrap. Refer to backend/requirements.txt for specific packages used in the backend, and to package.json for specific packages used in the frontend.

API Documentation can be viewed at localhost:8000/docs.

Directory Structure

• backend contains all components for the backend, in Django Directory Structure
  • Tests are thus in /backend/direcor/tests.py
• frontend contains all components for the frontend, with React components placed in /frontend/js/components, and tests in /frontend/js/tests