diff --git a/README.md b/README.md new file mode 100644 index 00000000..042675c0 --- /dev/null +++ b/README.md @@ -0,0 +1,118 @@ +# ft_transcendence + +This is our ft_transcendence, the last project from the common core of 42 school
+The project is the result of the colaboration between [shackbei](https://github.com/shackbei), [tgrossma](https://github.com/tobbel42), [mstrantz](https://github.com/imexz) and [tblaase](https://github.com/tblaase). + + +# Contents +- [Overview](#overview) +- [Env File](#env-file) +- [How to launch](#how-to-launch) + + +## Overview +In this project we were challanged to create a website where you can play pong and interact with other users.
+For loggin into the page we had to use the [42 intra API](https://api.intra.42.fr/apidoc).
+Here is some example pictures from our project: + +
+ show login page + + ![login](/readme_additions/login.png)
+
+ +--- + +
+ show profile page + + ![profile](/readme_additions/profile.png) +
+--- + +
+ show profile settings page + +![settings](/readme_additions/settings.png) +
+ +--- + +
+ show pregame page + +![pregame](/readme_additions/pre_game.png) +
+ +--- + +
+ show ingame page + +![ingame](/readme_additions/in_game.png) +
+ +--- + +
+ show after game page + +![ingame](/readme_additions/after_game.png) +
+ +--- + +
+ show scoreboard page + +![scoreboard](/readme_additions/scoreboard.png) +
+ +--- + +
+ show chat page + +![chat](/readme_additions/chat.png) +
+ +--- + +
+ show chat owner page + +![chat_admin](/readme_additions/chat_owner.png) +
+ + +## Env File +⚠️ The file has to be named `.env` and it has to have this path `/src/backend/.env`
+⚠️ NEVER publish this `.env` file since it may contain sensitive data as for example your API secret.
+Theses following variables have to be set inside the file:
+- `CLIENT_ID` can be found on intra +- `CLIENT_SECRET` can be found on intra +- `HOST` this will be the IP-address of your server, i.e. `http://localhost` +- `CALLBACK` this will be the same url as the callback-url in your intra, i.e. `http://localhost:3000/auth/login/callback` +- `POSTGRES_USER` this will be the username for seting up and accessing the database +- `POSTGRES_PASSWORD` this will be the password for the user above +- `PGDATABASE` this will be the name of your database +- `JWT_PASSWORD` this will be the password of your JWT-service +- `TWO_FACTOR_AUTHENTICATION_APP_NAME` this will be name of your 2FA app + + +[here](/src/backend/env_example.txt) you can find an example `.env`
+ +## How to launch +You need: +- Docker +- 2gb of discspace for the Docker-Images +- 42Intra API Key + + +Compile the program via the Makefile by using ```make``` or ```make all``` in the root directory of the repository. + + +For shutting down the server but not deleting anything use ```make down``` in the root of the repo. + + +For deleting every docker conatiner/image/volume that is currently not used, use ```make clean``` in the root of the repo. diff --git a/readme_additions/after_game.png b/readme_additions/after_game.png new file mode 100644 index 00000000..2450c4d5 Binary files /dev/null and b/readme_additions/after_game.png differ diff --git a/readme_additions/chat.png b/readme_additions/chat.png new file mode 100644 index 00000000..91817518 Binary files /dev/null and b/readme_additions/chat.png differ diff --git a/readme_additions/chat_owner.png b/readme_additions/chat_owner.png new file mode 100644 index 00000000..c0370a23 Binary files /dev/null and b/readme_additions/chat_owner.png differ diff --git a/readme_additions/in_game.png b/readme_additions/in_game.png new file mode 100644 index 00000000..27007caa Binary files /dev/null and b/readme_additions/in_game.png differ diff --git a/readme_additions/login.png b/readme_additions/login.png new file mode 100644 index 00000000..19cc4733 Binary files /dev/null and b/readme_additions/login.png differ diff --git a/readme_additions/pre_game.png b/readme_additions/pre_game.png new file mode 100644 index 00000000..0469108f Binary files /dev/null and b/readme_additions/pre_game.png differ diff --git a/readme_additions/profile.png b/readme_additions/profile.png new file mode 100644 index 00000000..977651ce Binary files /dev/null and b/readme_additions/profile.png differ diff --git a/readme_additions/scoreboard.png b/readme_additions/scoreboard.png new file mode 100644 index 00000000..8fc61b63 Binary files /dev/null and b/readme_additions/scoreboard.png differ diff --git a/readme_additions/settings.png b/readme_additions/settings.png new file mode 100644 index 00000000..374c64c7 Binary files /dev/null and b/readme_additions/settings.png differ