ft_transcendence

Table of Contents

• Overview
• Features
• Prerequisites
• Installation
• Usage
• Stopping the Application

Overview

This project is a web application that includes a backend, a frontend, and an Nginx server. It is containerized using Docker and managed via Docker Compose.

Features

• Real-time multiplayer Pong game
• User authentication and profiles
• Tournament system
• Live chat functionality
• Responsive web design
• Showcase:

Prerequisites

Before you begin, ensure you have the following installed:

• Docker
• Docker Compose
• Make

Installation

1. Clone the Repository

git clone https://github.com/ivotints/ft_transcendence.git
cd ft_transcendence

2. Run the Application

sudo make run

This command builds the Docker images and starts the containers for:

• Database (PostgreSQL 15)
• Backend server (Django)
• Frontend application
• Nginx server (reverse proxy with SSL)

Note: The frontend is located in nginx/var/www/html.

Available Make Commands

The project includes a convenient Makefile with the following commands:

sudo make run        # Start all services
sudo make stop       # Stop all services
sudo make build      # Build all images
sudo make rebuild    # Rebuild and start all services
sudo make clean      # Stop and remove all containers and volumes
sudo make clean-all  # Complete Docker cleanup (removes all containers, images, volumes)
sudo make logs       # Show logs for all services
sudo make restart    # Restart all services
sudo make status     # Show status of all services
sudo make shell-web  # Open shell in web container
sudo make shell-db   # Open shell in database container
make help            # Show all available commands

Usage

Once the containers are up, open your browser and navigate to:

https://localhost/

You can view the main frontend entry script here: app.js

Note: The application uses HTTPS with self-signed certificates, so your browser may show a security warning. Click "Advanced" and "Proceed to localhost (unsafe)" to continue.

Stopping the Application

To stop the application:

sudo make stop

Troubleshooting

If you encounter issues:

1. Clean up Docker environment:

   sudo make clean-all

2. Check container status:

   sudo make status

3. View logs:

   sudo make logs