BookStack Code Mirror - bookstack/blob - dev/docs/development.md

   1 # Development & Testing
   2
   3 All development on BookStack is currently done on the `development` branch.
   4 When it's time for a release the `development` branch is merged into release with built & minified CSS & JS then tagged at its version. Here are the current development requirements:
   5
   6 * [Node.js](https://nodejs.org/en/) v16.0+
   7
   8 This project uses SASS for CSS development and this is built, along with the JavaScript, using a range of npm scripts. The below npm commands can be used to install the dependencies & run the build tasks:
   9
  10 ``` bash
  11 # Install NPM Dependencies
  12 npm install
  13
  14 # Build assets for development
  15 npm run build
  16
  17 # Build and minify assets for production
  18 npm run production
  19
  20 # Build for dev (With sourcemaps) and watch for changes
  21 npm run dev
  22 ```
  23
  24 BookStack has many integration tests that use Laravel's built-in testing capabilities which makes use of PHPUnit. There is a `mysql_testing` database defined within the app config which is what is used by PHPUnit. This database is set with the database name, username and password all defined as `bookstack-test`. You will have to create that database and that set of credentials before testing.
  25
  26 The testing database will also need migrating and seeding beforehand. This can be done by running `composer refresh-test-database`.
  27
  28 Once done you can run `composer test` in the application root directory to run all tests. Tests can be ran in parallel by running them via `composer t`. This will use Laravel's built-in parallel testing functionality, and attempt to create and seed a database instance for each testing thread. If required these parallel testing instances can be reset, before testing again, by running `composer t-reset`.
  29
  30 ## Code Standards
  31
  32 PHP code standards are managed by [using PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer).
  33 Static analysis is in place using [PHPStan](https://phpstan.org/) & [Larastan](https://github.com/nunomaduro/larastan).
  34 The below commands can be used to utilise these tools:
  35
  36 ```bash
  37 # Run code linting using PHP_CodeSniffer
  38 composer lint
  39
  40 # As above, but show rule names in output
  41 composer lint -- -s
  42
  43 # Auto-fix formatting & lint issues via PHP_CodeSniffer phpcbf
  44 composer format
  45
  46 # Run static analysis via larastan/phpstan
  47 composer check-static
  48 ```
  49
  50 If submitting a PR, formatting as per our project standards would help for clarity but don't worry too much about using/understanding these tools as we can always address issues at a later stage when they're picked up by our automated tools.
  51
  52 ## Development using Docker
  53
  54 This repository ships with a Docker Compose configuration intended for development purposes. It'll build a PHP image with all needed extensions installed and start up a MySQL server and a Node image watching the UI assets.
  55
  56 To get started, make sure you meet the following requirements:
  57
  58 - Docker and Docker Compose are installed
  59 - Your user is part of the `docker` group
  60
  61 If all the conditions are met, you can proceed with the following steps:
  62
  63 1. **Copy `.env.example` to `.env`**, change `APP_KEY` to a random 32 char string and set `APP_ENV` to `local`.
  64 2. Make sure **port 8080 is unused** *or else* change `DEV_PORT` to a free port on your host.
  65 3. **Run `chgrp -R docker storage`**. The development container will chown the `storage` directory to the `www-data` user inside the container so BookStack can write to it. You need to change the group to your host's `docker` group here to not lose access to the `storage` directory.
  66 4. **Run `docker-compose up`** and wait until the image is built and all database migrations have been done.
  67 5. You can now login with `[email protected]` and `password` as password on `localhost:8080` (or another port if specified).
  68
  69 If needed, You'll be able to run any artisan commands via docker-compose like so:
  70
  71 ```bash
  72 docker-compose run app php artisan list
  73 ```
  74
  75 The docker-compose setup runs an instance of [MailHog](https://github.com/mailhog/MailHog) and sets environment variables to redirect any BookStack-sent emails to MailHog. You can view this mail via the MailHog web interface on `localhost:8025`. You can change the port MailHog is accessible on by setting a `DEV_MAIL_PORT` environment variable.
  76
  77 ### Running tests
  78
  79 After starting the general development Docker, migrate & seed the testing database:
  80
  81  ```bash
  82 # This only needs to be done once
  83 docker-compose run app php artisan migrate --database=mysql_testing
  84 docker-compose run app php artisan db:seed --class=DummyContentSeeder --database=mysql_testing
  85 ```
  86
  87 Once the database has been migrated & seeded, you can run the tests like so:
  88
  89  ```bash
  90 docker-compose run app php vendor/bin/phpunit
  91 ```
  92
  93 ### Debugging
  94
  95 The docker-compose setup ships with Xdebug, which you can listen to on port 9090.
  96 NB : For some editors like Visual Studio Code, you might need to map your workspace folder to the /app folder within the docker container for this to work.