Skip to content

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

License

Notifications You must be signed in to change notification settings

fairnesscoop/pictyschool

Repository files navigation

Pictyschool

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

GitHub Workflow Status codecov Scrutinizer Code Quality Codacy Badge GitHub release (latest by date) GitHub license

Technical stack

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

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": "john@doe.com",
    "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