busshi/transcendance_back repository overview

⁠ft_transcendance (BACK)

A frankly over-engineered but not less cool web implementation of the Pong game.

⁠Development

⁠Architecture

The following diagram represents the whole architecture of the project. Every cube is an individual docker container.

⁠Run the development cluster

A special docker-compose file named docker-compose.dev.yml is available for development. One can start the development cluster with:

docker-compose -f src/docker-compose.dev.yml up --build [-d]

⁠IMPORTANT NOTE: slow startup for NextJS and NestJS containers

By default, the entrypoint.dev.sh script will attempt to install the required dependencies using yarn install from within the container. As the folder in which the app resides is bind-mounted, installing the dependencies from the container may take more time than doing so directly on the host system. If yarn is installed on the host system, it is recommended to yarn install from the host prior running the development cluster so that nothing has to be installed inside the container.

⁠Frontend developers

Connect to http://127.0.0.1:3000 in your browser to access the NextJS React application (in development only). Every change will trigger a hot reload, which means that the browser will instantly reflect the changes. Alternatively, it is possible to connect to the app through the reverse proxy on http://127.0.0.1 (no port == port 80), but this is not recommended during development as it will not enable the hot reload feature.

⁠Backend developers

The NestJS API can be accessed on http://127.0.0.1:5000 (during development only) or on http://127.0.0.1/api (dev && prod). The api prefix is not part of the actual API route and is only there to properly proxy the request to the right service. In dev mode, every change made to the Nest app causes it to instantly reload.

Don't forget to install the NestJS command line tool:

yarn global add @nestjs/cli
# OR, if using npm
npm install -g @nestjs/cli

⁠Troubleshooting

The following commands may prove useful to troubleshoot issues:

⁠Check container status

docker-compose -f src/docker-compose.dev.yml ps

⁠Check container logs

docker-compose -f src/docker-compose.dev.yml logs [container_name]

⁠About development

This cluster makes use of the development build of NextJS and NestJS and uses special Dockerfiles labelled has Dockerfile.dev. Essentially, what happens is that the source code repository for each application is bind-mounted inside the docker container, so that it runs in the container, but anyone can change the source code directly from the host system and reload the application almost immediately. Additionally, no .env file is used in development.

On the other hand, The production cluster (currently a work in progress) builds everything inside the image and does not depend on the host filesystem, while making use of the production build of NestJS and NextJS.