Installation

• Install the latest version of docker-ce. ( Ubuntu | Debian )

• Install the latest version of docker-compose via pip

• Install the latest version of npm

• Add your user to the docker group, using sudo adduser $USER docker, them logout/logback to your computer

• Copy docker-compose.dist.yml to docker-compose.yml

• Then run the ./aliases.sh install script.

• Use ng serve --port={PORT} to access app on http://localhost:{PORT}/

• if the connexion doesn't work, try

   ./docker.sh console doctrine:migration:migrate
   ./docker.sh console doctrine:fixture:load -n
  

### Generate your JWT keys

YtSeries need public/private key to generate JWT tokens. Those tokens are used by API for authentication and reconnection mechanisms.

Execute the following commands within /back folder

mkdir -p config/jwt

openssl genrsa -out config/jwt/private.pem -aes256 4096
openssl rsa -pubout -in config/jwt/private.pem -out config/jwt/public.pem
openssl rsa -in config/jwt/private.pem -out config/jwt/private2.pem

mv config/jwt/private2.pem config/jwt/private.pem
chmod 777 config/jwt/*

How work on YtSeries

Coding style and Standards

• Respect best practices for javascript and php.
• Respect PSR-2 coding standards for all php files.
• Respect PHP mess detector.
• Respect every PSR for php files/classes.
• Respect AirBnB standards guideline for javascript.
• Respect PHPdoc standard.

Try to inspire you as mush as you can of functional programing, it will make your code cleaner, reusable and easy to test. You will find equivalent in every programming language.

Git

• Follow the documentation to learn who to use git on this project.
• Please use the git configuration of this project.

Git hooks exist as simple text files in your /hooks directory. They are inject inside .git/hooks using symbolic link.

pre-commit checkup

• JS console.log finder
• PHP dump finder
• Merge tag finder
• PSR-2 checkup
• PHP Mess Detector Checkup
• TsLint checkup

Checks will run only over the committed code base

Every day usage

Run the ./aliases.sh reload script and start coding!

Useful PHP commands

./aliases.sh php ...

Direct access to php

./aliases.sh composer ...

Use composer inside /server folder (flex ready)

./aliases.sh console ...

Direct access to symfony console

./aliases.sh phpcs ...

Direct access to phpcs

./aliases.sh phpmd ...

Direct access to phpmd

./aliases.sh phpunit ...

Direct access to phpunit

Useful Database commands

./aliases.sh psql ...

Direct access to postgres