Stud Asso

// TODO: Add Logo

Since the health crisis, the associative life has difficulties relaunching itself and the multiplicity of communication platforms makes the whole chaotic.

The Stud'Asso project aims to relaunch and simplify communication between associations and students. But also to simplify the management processes of associations, from recruitment to the publication of events, all customizable by the user.

Moreover, the application will simplify the exchanges between associations and school's administration in order to allow the latter to obtain a simple vision of all the associations through statistics.

Installation Guide

Required softwares to run the application:

• Node
• Npm

You can find the exact Node version in .nvmrc

We recommend having Nx globaly installed:

npm install -g nx

Install the dependencies:

npm ci

Running the project:

nx serve backend # Port: 3333
nx serve frontend-school # Port: 4200
nx serve frontend-association # Port: 4201
nx serve frontend-student

PostgreSQL installation

We are using PostgreSQL to manage our data. We recommend using docker to install it.

docker-compose -f docker-compose.yml up -d database

.env

Add in a .env file at the root of the project :

DATABASE_URL="postgresql://postgres:password@localhost:5432/studasso?schema=public"

Work with prisma

To create a migration without modifications:

npx prisma migrate dev

To customize your migration:

npx prisma migrate dev --create-only
# once you're finished customizing:
npx prisma migrate dev

To run new migrations after a pull

npx prisma migrate dev

To generate PrismaClient (to do after each modification in database schema (prisma.schema)):

npx prisma generate

Install the precommit

It should be automatically installed when running:

npm ci

Running the linter

You can run the linter using:

nx affected:lint

Running test

You can run the test using:

nx affected:test

How to add a new feature in backend

When creating a new ressource:

• add dtos to libs/shared/dtos/src/lib, and export them in libs/shared/dtos/src/index.ts
• add entities to libs/backend/core/orm/src/lib and export them in libs/backend/core/orm/src/index.ts
• add feature to libs/backend/feature/