This is an application designed to help story writers to keep track of various elements like scenes, characters, items or events.
If you wish to start your own instance of the application, you will need:
- Composer + PHP 7.2+ along with extensions listed in composer.json
- Yarn + node.js 10
- Webpack 4
- MySQL 5.7
composer.phar install
yarn install
Just run webpack
or node_modules/.bin/webpack
if you do not have a global Webpack installation.
The application is build around the Symfony framework and has a concept of environments (for production, testing and development), more here. For each environment the application expects a different database to prevent data from different ones mixing together. You can create each one with the following commands:
bin/console doctrine:database:create --env={one of: dev,test,test_cypress,prod}
bin/console doctrine:schema:create --env={one of: dev,test,test_cypress,prod}
# if you want to load test data
bin/console doctrine:fixtures:load -n --group=development --env={one of: dev,test,test_cypress,prod}
At this point you basically have a running setup. I will try to provide a docker-compose.yml
file sometime in the future to provide an out-of-the-box environment for development.