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 ## Building CSS & JavaScript Assets
   9
  10 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:
  11
  12 ``` bash
  13 # Install NPM Dependencies
  14 npm install
  15
  16 # Build assets for development
  17 npm run build
  18
  19 # Build and minify assets for production
  20 npm run production
  21
  22 # Build for dev (With sourcemaps) and watch for changes
  23 npm run dev
  24 ```
  25
  26 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.
  27
  28 The testing database will also need migrating and seeding beforehand. This can be done by running `composer refresh-test-database`.
  29
  30 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`.
  31
  32 If the codebase needs to be tested with deprecations, this can be done via uncommenting the relevant line within the TestCase@setUp function.
  33
  34 ## Code Standards
  35
  36 PHP code standards are managed by [using PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer).
  37 Static analysis is in place using [PHPStan](https://phpstan.org/) & [Larastan](https://github.com/nunomaduro/larastan).
  38 The below commands can be used to utilise these tools:
  39
  40 ```bash
  41 # Run code linting using PHP_CodeSniffer
  42 composer lint
  43
  44 # As above, but show rule names in output
  45 composer lint -- -s
  46
  47 # Auto-fix formatting & lint issues via PHP_CodeSniffer phpcbf
  48 composer format
  49
  50 # Run static analysis via larastan/phpstan
  51 composer check-static
  52 ```
  53
  54 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.
  55
  56 ## Development using Docker
  57
  58 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.
  59
  60 To get started, make sure you meet the following requirements:
  61
  62 - Docker and Docker Compose are installed
  63 - Your user is part of the `docker` group
  64
  65 If all the conditions are met, you can proceed with the following steps:
  66
  67 1. **Copy `.env.example` to `.env`**, change `APP_KEY` to a random 32 char string and set `APP_ENV` to `local`.
  68 2. Make sure **port 8080 is unused** *or else* change `DEV_PORT` to a free port on your host.
  69 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.
  70 4. **Run `docker-compose up`** and wait until the image is built and all database migrations have been done.
  71 5. You can now login with `[email protected]` and `password` as password on `localhost:8080` (or another port if specified).
  72
  73 If needed, You'll be able to run any artisan commands via docker-compose like so:
  74
  75 ```bash
  76 docker-compose run app php artisan list
  77 ```
  78
  79 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.
  80
  81 ### Running tests
  82
  83 After starting the general development Docker, migrate & seed the testing database:
  84
  85  ```bash
  86 # This only needs to be done once
  87 docker-compose run app php artisan migrate --database=mysql_testing
  88 docker-compose run app php artisan db:seed --class=DummyContentSeeder --database=mysql_testing
  89 ```
  90
  91 Once the database has been migrated & seeded, you can run the tests like so:
  92
  93  ```bash
  94 docker-compose run app php vendor/bin/phpunit
  95 ```
  96
  97 ### Debugging
  98
  99 The docker-compose setup ships with Xdebug, which you can listen to on port 9090.
 100 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.