Set up development environment

Requirements:

• PHP version 7.4
• Node version 14
• Git

Required PHP-dependencies:

• ext-pdo_sqlite
• ext-gd2
• ext-mbstring
• ext-curl
• ext-xml

How to install the php-dependencies

Please find the file php.ini. (On Linux it is located at /etc/php/version/cli/php.ini).

Uncomment all lines with the required PHP-dependencies.

Example for dependency mbstring:

;extension=mbstring ---> extension=mbstring

To install the PHP-dependencies on Ubuntu (Example with Ubuntu as operating system and a php-version of 7.4)

sudo apt-get install php7.4-mbstring
sudo apt-get install php7.4-sqlite (php7.4-mysql for prod)
sudo apt-get install php7.4-gd
sudo apt-get install php7.4-curl
sudo apt-get install php7.4-xml

Alternatively install Composer dependency manager from here. Then run composer install.

Setup:

Clone files:

git clone https://github.com/vektorprogrammet/vektorprogrammet.git

UNIX:

npm run setup

Windows:

npm run setup:win

Start server on http://localhost:8000

npm start

Build static files

When adding new images or other non-code files, you can run:

npm run build

so that the files are put in the correct places. (this is automatically done when doing npm start)

Users

Code style

Code style should follow a certain set of rules. Make sure your code adheres to these rules before opening a PR.

Fix style

UNIX/LINUX:

npm run -s cs

Windows:

npm run -s cs:win

Testing

Tests should be run before opening a PR.

UNIX/LINUX:

npm run test

Windows:

npm run test:win

File specific test:

npm run test "tests/PATH_TO_TEST"

or (without needing the exact path)

npm run test -- --filter "NAME_OF_FILE"

Database

Add new entities to the database and reload fixtures

npm run db:update

Reload database

npm run db:reload

Docker:

Build docker image: npm run docker:build

Set up docker image: npm run docker:setup

Run commands in docker image npm run docker:run -- <CMD>

e.g. npm run docker:run -- npm run db:update