README.md

MemoRekallMember web app

This project has been created to help artists document their creative process with video notes and documents.

Installation

Copy the file .env_default to .env and adapt it to your needs

Run the following commands

# Clone the docker stack
git clone https://gitlab.tetras-libre.fr/rekall/docker-stack-new
cd docker-stack-new
# Clone the symfony app
git clone https://gitlab.tetras-libre.fr/rekall/memorekall-member-new app
# Build and start the containers
docker-compose up --build
# In another terminal
docker-compose exec memorekall-member php bin/console doctrine:schema:create

Developpement only

You need to add a test database to run the automated tests :

1. open a mysql shell : docker-compose exec mysql mysql -u root -p'youRootPasswordDefinedInDotEnvFile

create database rekallfrwsmember_test
grant all privileges on rekallfrwsmember_test.* to rekallfrwsmember;
exit

2. Create the database schema docker-compose exec memorekall-member php bin/console --env=test doctrine:schema:create

Contributors

The Tetras Libre team follows some code quality requirements. Indeed, to ensure the respect of the standards PHP rules, we use a pre-commit hook as a safety net before sending any contribution. The following quality tool scripts will be triggered before reaching commit message editor.

• PHPUnit (functional and unit tests)
• PHP_CodeSniffer (for PSR standards)
• PHPSTAN (for static analysis)

---

How to run the code quality scripts?

First, you need to enter the memorekall-member docker container: docker-compose exec memorekall-member bash

• To run the script independently of a commit: composer {phpcs/phpstan/tests}
• To fix PHP_CodeSniffer errors: composer phpcbf
• To run unit tests composer tests
• To run them all: composer ci

How to contribute to the MemoRekall project?

Please configure your local git as follows:

1. From your terminal, run: git config core.hooksPath ./tools/git-hooks/
2. Make the pre-commit hook executable running: sudo chmod +x ./tools/git-hooks/pre-commit