You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Changed the default admin login email [email protected] to [email protected], because the domain admin.com can possible cause problems in email servers at some point
Copy file name to clipboardExpand all lines: dev/docs/development.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,15 @@
1
1
# Development & Testing
2
2
3
-
All development on BookStack is currently done on the `development` branch.
3
+
All development on BookStack is currently done on the `development` branch.
4
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
5
6
-
*[Node.js](https://nodejs.org/en/) v18.0+
6
+
-[Node.js](https://nodejs.org/en/) v18.0+
7
7
8
8
## Building CSS & JavaScript Assets
9
9
10
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
11
12
-
```bash
12
+
```bash
13
13
# Install NPM Dependencies
14
14
npm install
15
15
@@ -29,7 +29,7 @@ The testing database will also need migrating and seeding beforehand. This can b
29
29
30
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
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.
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
33
34
34
## Code Standards
35
35
@@ -81,10 +81,10 @@ To get started, make sure you meet the following requirements:
81
81
If all the conditions are met, you can proceed with the following steps:
82
82
83
83
1.**Copy `.env.example` to `.env`**, change `APP_KEY` to a random 32 char string and set `APP_ENV` to `local`.
84
-
2. Make sure **port 8080 is unused***or else* change `DEV_PORT` to a free port on your host.
84
+
2. Make sure **port 8080 is unused**_or else_ change `DEV_PORT` to a free port on your host.
85
85
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.
86
86
4.**Run `docker-compose up`** and wait until the image is built and all database migrations have been done.
87
-
5. You can now login with `admin@admin.com` and `password` as password on `localhost:8080` (or another port if specified).
87
+
5. You can now login with `admin@example.com` and `password` as password on `localhost:8080` (or another port if specified).
88
88
89
89
If needed, You'll be able to run any artisan commands via docker-compose like so:
90
90
@@ -98,15 +98,15 @@ The docker-compose setup runs an instance of [MailHog](https://github.com/mailho
98
98
99
99
After starting the general development Docker, migrate & seed the testing database:
100
100
101
-
```bash
101
+
```bash
102
102
# This only needs to be done once
103
103
docker-compose run app php artisan migrate --database=mysql_testing
104
104
docker-compose run app php artisan db:seed --class=DummyContentSeeder --database=mysql_testing
105
105
```
106
106
107
107
Once the database has been migrated & seeded, you can run the tests like so:
0 commit comments