⚠️ Warning

This project has been made for educational purpose, it is not production ready. Some security caveats might exist, and no further work has been planned to fix them.

About The Project

ft_transcendence is a 42 project, aiming to create a pong-like game using NestJS as backend framework, any TypeScript framework for frontend, and get this altogether using docker compose.

You can find complete subject here.

Built With

• Docker
• NestJS
• Vue.js
• PostgreSQL / TypeORM

Getting Started

Prerequisites

• Docker and Docker compose

Installation

1. Clone the repo

git clone https://github.com/kema-dev/ft_transcendence.git

2. Go to repository's folder

cd ft_transcendence

3. Create .env file from .env.example template

cp .env.example .env

4. Change default values (passwords, emails...) and replace PLACEHOLDERS under # Your environment ? in .env file

Usage

• Dev environment

docker compose up --build

• Prod environment (do not forget to change VUE_PHASE to build and NEST_PHASE to start:prod in .env file)

docker-compose --profile prod up --build

Below is a list of links to website's pages (assuming you're using default values in .env file):

• website - website served by vue.js
• api - REST api served by nestjs
• pgadmin - PostgreSQL administration tool

Contact

We are 3 creators :

kema-dev - GitHub

oc8 - GitHub

Totolosa - GitHub

Acknowledgments

• Img Shields
• README.MD-Template