vsv-verkeerskunde / gvq-api
GVQ API
Requires
- php: ^7.2.4
- ext-iconv: *
- ext-json: *
- ext-redis: *
- broadway/broadway: ^2.0
- doctrine/orm: ^2.6
- league/flysystem: ^1.0
- league/flysystem-aws-s3-v3: ^1.0
- league/uri: ^5.3
- ramsey/uuid: ^3.7
- ramsey/uuid-doctrine: ^1.4
- symfony/asset: ^4.0
- symfony/cache: ^4.0
- symfony/console: ^4.0
- symfony/expression-language: ^4.0
- symfony/flex: ^1.0
- symfony/form: ^4.0
- symfony/framework-bundle: ^4.0
- symfony/lts: ^4@dev
- symfony/monolog-bundle: ^3.3
- symfony/orm-pack: ^1.0
- symfony/security-bundle: ^4.0
- symfony/serializer: ^4.0
- symfony/swiftmailer-bundle: ^3.2
- symfony/translation: ^4.0
- symfony/twig-bundle: ^4.0
- symfony/validator: ^4.0
- symfony/yaml: ^4.0
Requires (Dev)
- php-coveralls/php-coveralls: ^2.0
- phpstan/phpstan: ^0.9.2
- phpunit/phpunit: ^7.1
- squizlabs/php_codesniffer: ^3.2
- symfony/debug: ^4.0
- symfony/dotenv: ^4.0
- symfony/profiler-pack: ^1.0
- symfony/web-server-bundle: ^4.0
Conflicts
This package is not auto-updated.
Last update: 2024-09-13 09:51:20 UTC
README
播种
初始设置
使用从 .env
文件中获取的设置创建一个新的数据库
$ ./bin/console doctrine:database:create
使用以下命令在此数据库中创建表
$ ./bin/console doctrine:schema:create
播种分类
可以使用以下自定义命令添加所有固定分类
$ ./bin/console gvq:seed-categories
使用可选的文件参数,可以指定包含分类的任意文件。
播种用户
将包含的 fixed_users.yaml.dist
文件重命名为 fixed_users.yaml
或创建自己的数据文件。可以使用以下自定义命令添加所有固定用户
$ ./bin/console gvq:seed-users
使用可选的文件参数,可以指定包含用户的任意文件。
Docker
基础
编辑您的 host 文件并添加以下内容
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
通过运行以下命令安装源
$ composer install
通过运行以下命令启动 Docker
$ docker-compose up -d
在: http://gvq-api.test:8000/ 连接到 api
在: http://mailhog.gvq-api.test:8025/ 连接到 mailhog
在: mysql.gvq-api.test:33066 连接到 MySQL
数据库
使用以下命令创建架构(确保在 .env
中有正确的 DATABASE_URL
字符串)
$ docker-compose exec web bash -c "./bin/console doctrine:schema:create"
DATABASE_URL
的示例,其中包含 .env
中的值
DATABASE_URL=mysql://$DB_USER:$DB_PASSWORD@$DB_HOST:3306/$DB_NAME
播种分类(默认从 categories.yaml 中获取)
$ docker-compose exec web bash -c "./bin/console gvq:seed-categories"
播种用户(确保提供输入文件)
$ docker-compose exec web bash -c "./bin/console gvq:seed-users"
图片上传
如果您想使用 s3 作为上传位置,请在 env
中更改
UPLOAD_TARGET=remote
UPLOAD_PATH=*url_to_s3_bucket*
示例
UPLOAD_TARGET=remote
UPLOAD_PATH=https://s3-eu-west-1.amazonaws.com/verkeersquiz-test/
并填写必要的凭据和存储桶详细信息。
要使用本地文件系统,请保持默认值不变
UPLOAD_TARGET=local
UPLOAD_PATH=/uploads/
修改样式 / CSS
请参阅 assets/README.md 中的文档。