// 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.
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 nxInstall the dependencies:
npm ciRunning the project:
nx serve backend # Port: 3333
nx serve frontend-school # Port: 4200
nx serve frontend-association # Port: 4201
nx serve frontend-studentWe are using PostgreSQL to manage our data. We recommend using docker to install it.
docker-compose -f docker-compose.yml up -d database
Add in a .env file at the root of the project :
DATABASE_URL="postgresql://postgres:password@localhost:5432/studasso?schema=public"
npx prisma migrate devnpx prisma migrate dev --create-only
# once you're finished customizing:
npx prisma migrate devnpx prisma migrate devnpx prisma generateIt should be automatically installed when running:
npm ci
You can run the linter using:
nx affected:lint
You can run the test using:
nx affected:test
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/