b-ki / ft_transcendence Goto Github PK

Makefile 0.44% JavaScript 1.69% Dockerfile 0.57% TypeScript 96.84% HTML 0.17% CSS 0.20% Shell 0.08%

ft_transcendence's Introduction

Welcome to ft_transcendance !

Folder stucture

We have 3 main folders:

api that contains the Nest.js application, which is the API backend of our application
front that contains the React.js application, which is the frontend UI for our application
db that contains nothing for now but might contains the database schema specifications (tables and all)

Each of the api and front directories have their own directions on how to start their application so you can check there for more informations.

How to run the project

There is two main ways to launch this application, one for development and one for production, and everything can be done with Docker and the Makefile

The Dev environment

In order to start the project with the objective to develop something either on the API or on the front you can run make dev.
This will automaticaly build the images for you and launch the project and the containers with everything.
You can now open your favourite code editor and start coding some feature (I see you, start working now).

The Prod environment

If you want to start the project in its final and optimized form in order to ship it for production on a server, go ahead and type make prod
This will compile and start the project with everything ready for production.
Be aware that in this environment you CANNOT dynamically change files to modify the render. If you want to change something you need to rebuild the application.

Usefull commands for the project

There is some commands to help you visualize what is happening inside the containers. I'll let you check more in depth the Makefile for more infos but here is it works in general:
When you see %.something, this means that the rule is available for both dev and prod environment. But you need to add dev or prod before all of your commands.
Let's take the example of the %.logs command. If you started your environment in dev mode with make dev you need to use the command make dev.logs in order to see the logs of your containers. If you want to cleanup your environment you will do make dev.clean.
And its the same for every command

ft_transcendence's People

Contributors

Watchers

Forkers

nthimoni

ft_transcendence's Issues

Make Notification component

Make profile page

Leaving channel show no more channels

When in several channel, if leaving one, no more channels are visible. Need to refresh the page to view them.

When new DM get error "login must be shorter or equal to 8 characters"

Setup Database connection and ORM in Nest.js

End to end tests

Write end to end tests

Chat: show user picture next to message

and make it clickable

2FA: Invisible input text box

The text box for the 2FA code is invisible.

Auth module tests

Write the test architecture. Test file for :

module
controller
service

Setup Actions to run linters on front and back plus build

Change image for find someone button

Lost 3 games, but number total of lost game is 1 on profile page

Chat: change channel visibility / password

Fix add a friend button

Request probably not working

Add notify socket to front

add a default banner

User module tests

Write the test architecture. Test file for :

module
controller
service

Protect User POST request from others

Sometimes, can't access other profile page, error "login is undefined"

I don't know how to reproduce the bug yet, but happens when someone else tested the app

Regroup ts and jest configuration in 2 files

For ts is configured in tsconfig.json, and jest in package.json

Place the jest configuration in jest.json and not in package

Make Input component

Setup the project and the Docker stuff

Need to create the React projet and the Nest.js project to be able to start each end of the development.
Also need to setup the docker-compose to launch either in production and in development

Modify useApi() to use parameters such as 'enabled'

useQuery can use a parameter 'enabled: boolean', with a condition that triggers the query or not (example : don't do request if no token, enabled: !!token)
useApi() uses useQuery but we can't provide { enabled: condition } in it.

Need to refresh to get friend status (online, offline, etc.)

Setup Tailwind in Front + React Router

Make Icon component

Make login page

Create remove friend button in DM

Define and create all User endpoints

Create pipe validation for userendpoints

Make fclean does not clean db

db docker still up with make fclean

Fix linter error front

in /front run pnpm run lint and fix all errors

Chat: direct messages

Ajouter l'ID et le createdAt du channel pour l'event `youJoined`

Actuellement après avoir créé un channel, l'event youJoined est trigger, or il ne contient que les champs name et type. Alors que pour channelList et joinedList il y a aussi l'id et le createdAt ce qui est vraiment pratique. Ça rends les return values tres incohérentes.

Chat: block other users

La structure d'un message n'est pas harmonisée

Les requetes history et message ne return pas la meme stucture de donnée pour un message ce qui est très embetant.
history retourne:

interface MessageType {
  id: number;
  creadtedAt: string;
  content: string;
  channelId: number;
  authorId: number;
  author: User;
}

Alors que si on listen sur message ça retourne:

interface MessageType2 {
  content: string;
  channel: string;
  user: User;
}

Resultat tres embetant pcq du coup je ne peux pas stocker un tableau d'un type MessageType puisque la structure change en fonction de comment je recupere l'info

Review the localStorage logic. Don't store useQuery() return in react state

trojanowski/react-apollo-hooks#158

Anti pattern to store user in react state, maybe not the best things to do.

Change the AuthContext and the way token is stored in local storage