project gvq-api

vsv-verkeerskunde/gvq-api

API for GVQ

, _(*1)

Seeding

Initial setup

Create a new database with settings taken from .env file:, _(*2)

$ ./bin/console doctrine:database:create, _(*3)

Create the tables inside this database with:, _(*4)

$ ./bin/console doctrine:schema:create, _(*5)

Seeding categories

Adding all fixed categories can be done with the following custom command:, _(*6)

$ ./bin/console gvq:seed-categories, _(*7)

With the optional file argument it is possible to specify an arbitrary file with categories., _(*8)

Seeding users

Rename the included fixed_users.yaml.dist file to fixed_users.yaml or create your own data file. Adding all fixed users can be done with the following custom command:, _(*9)

$ ./bin/console gvq:seed-users, _(*10)

With the optional file argument it is possible to specify an arbitrary file with users., _(*11)

Docker

Basics

Edit the your host file and add the following:, _(*12)

127.0.0.1   gvq-api.test
127.0.0.1   mailhog.gvq-api.test
127.0.0.1   mysql.gvq-api.test
127.0.0.1   redis.gvq-api.test

Install sources by running:, _(*13)

$ composer install

Start docker by running:, _(*14)

$ docker-compose up -d

Connect to api on: http://gvq-api.test:8000/, _(*15)

Connect to mailhog on: http://mailhog.gvq-api.test:8025/, _(*16)

Connect to MySQL on: mysql.gvq-api.test:33066, _(*17)

Database

Create the schema with (make sure to have correct DATABASE_URL string inside .env):, _(*18)

$ docker-compose exec web bash -c "./bin/console doctrine:schema:create"

Example of DATABASE_URL with values inside .env:, _(*19)

DATABASE_URL=mysql://$DB_USER:$DB_PASSWORD@$DB_HOST:3306/$DB_NAME

Seeding categories (by default taken from categories.yaml), _(*20)

$ docker-compose exec web bash -c "./bin/console gvq:seed-categories"

Seeding users (make sure to provide an input file), _(*21)

$ docker-compose exec web bash -c "./bin/console gvq:seed-users"

Image upload

If you want to use s3 as upload location, then change inside env:, _(*22)

UPLOAD_TARGET=remote
UPLOAD_PATH=*url_to_s3_bucket*

Example:, _(*23)

UPLOAD_TARGET=remote
UPLOAD_PATH=https://s3-eu-west-1.amazonaws.com/verkeersquiz-test/

and fill in the necessary credential and bucket details., _(*24)

To use the local filesystem, leave the default values unchanged:, _(*25)

UPLOAD_TARGET=local
UPLOAD_PATH=/uploads/

Altering styling / CSS

See the documentation in assets/README.md., _(*26)