An open API service indexing awesome lists of open source software.

https://github.com/bima42/ft_transcendence

Single Page Application Website. Last project of 42 School common core.
https://github.com/bima42/ft_transcendence

nestjs typescript vue3 web

Last synced: 10 months ago
JSON representation

Single Page Application Website. Last project of 42 School common core.

Awesome Lists containing this project

README

          

# ft_transcendence
Single Page Application Website. This is the last project of 42 School common core.
This project is a website that includes a multiplayer pong game.

## Launch the project locally
### Clone the repository
```bash
git clone git@github.com:Bima42/ft_transcendence.git

cd ft_transcendence
```

### Setting up environment variables
- Rename `.env.example` to `.env`
- Change the values of the variables `FORTYTWO_API_UID` and `FORTYTWO_API_SECRET` in `.env` to match your environment
- You should also configure `JWT_KEY`

### Run containers
- Use `--build` to rebuild images
- Use `--force-recreate` to force recreate image and containers
- Use `-d` to run containers in background

```bash
docker compose up -d
```

### Reach the website
- Go to `https://localhost:4443`

## Documentation
- ### [Summary](docs/Summary.md)
- ### [Docker](docs/docker/0-what-is-docker.md)
- ### [Docker Commands](docs/docker/3-docker-usefull-commands.md)
- ### [Backend](docs/backend/0-what-is-nestjs.md)

## Website overview
### Login



### Home



### Profile



### Chat



#### Chat with a friend



### Game



#### In game



### Leaderboard