Skip to content

README.md

Latest commit

 

History

History
32 lines (21 loc) · 1.22 KB

README.md

File metadata and controls

32 lines (21 loc) · 1.22 KB

codecov

Development requirements

  • Symfony CLI
  • PHP 8.4, ideally with these extensions: mbstring and intl
  • Docker Compose
  • Make

Install

Run this command:

git clone git@github.com:Pierstoval/Conventionist.git
cd Conventionist
make install

Open the https://127.0.0.1:8000 page.

Two users are available at first:

  • User: admin, password: admin, with full access to the backoffice
  • User: visitor, password: visitor, with limited access: this user can only access entities for which they are "creator" (there's a Creators field in src/Entity, check it out).

If the backoffice itself is not self-explanatory, feel free to submit an issue, the goal is to make the project easy to use.

Licence

The project is under AGPL-3.0 licence.
TL;DR: If you use and customize this project, you must re-publish all the changes in public with the exact same licence, commercial or not. Shorter version: create a fork on Github, push your custom work there (simplest solution).