fairnesscoop / pictyschool

Open source and eco design school photo management software (work in progress)

PictySchool is an open source and eco design school photo management software

Technical stack

• Node.js / Nestjs
• TypeORM
• Typescript
• Jest / Ts-mockito
• Svelte / Sapper
• Tailwind CSS
• PostgreSQL
• Docker

Prerequisites

You must have Docker and Docker Compose.

Installation

At the first launch, just execute this command to install your application :

make install

For the next times you just need to execute this command to start your application :

make start

• API available on http://localhost/api
• Client available on http://localhost

Security

The client must send the user apiToken in the Authorization header when making requests to protected resources : Authorization: Bearer <apiToken>

At the installation of the project a default user was created :

{
    "email": "[e-mail]",
    "password": "john"
}

To retrieve the apiToken, make a post request on /login with a user email and password.

Helpers

This following command will display all available helpers :

make help

Tests

Run the unit test suite with this following command:

make test

Credits

Created by Fairness