Зуев Егор / wiki.dev

Go to a project
Toggle navigation
Toggle navigation pinning
Dan Brown
f91f33c2 1 parent 3f0ef57d

Updated readme attribution and npm scripts

Inline Side-by-side
Showing 2 changed files with 24 additions and 6 deletions
1 { 1 {
2 "private": true, 2 "private": true,
3 "scripts": { 3 "scripts": {
4 - "prod": "gulp --production", 4 + "build": "gulp --production",
5 - "dev": "gulp watch" 5 + "dev": "gulp watch",
6 + "watch": "gulp watch"
6 }, 7 },
7 "devDependencies": { 8 "devDependencies": {
8 "angular": "^1.5.5", 9 "angular": "^1.5.5",
......
...@@ -17,22 +17,33 @@ A platform for storing and organising information and documentation. General inf ...@@ -17,22 +17,33 @@ A platform for storing and organising information and documentation. General inf
17 17
18 All development on BookStack is currently done on the master branch. When it's time for a release the master branch is merged into release with built & minified CSS & JS then tagged at it's version. Here are the current development requirements: 18 All development on BookStack is currently done on the master branch. When it's time for a release the master branch is merged into release with built & minified CSS & JS then tagged at it's version. Here are the current development requirements:
19 19
20 -* [Node.js](https://nodejs.org/en/) 20 +* [Node.js](https://nodejs.org/en/) v6.9+
21 -* [Gulp](http://gulpjs.com/)
22 21
23 -SASS is used to help the CSS development and the JavaScript is run through browserify/babel to allow for writing ES6 code. Both of these are done using gulp. 22 +SASS is used to help the CSS development and the JavaScript is run through browserify/babel to allow for writing ES6 code. Both of these are done using gulp. To run the build task you can use the following commands:
23 +
24 +``` bash
25 +# Build and minify for production
26 +npm run-script build
27 +
28 +# Build for dev (With sourcemaps) and watch for changes
29 +npm run-script dev
30 +```
24 31
25 BookStack has many integration tests that use Laravel's built-in testing capabilities which makes use of PHPUnit. To use you will need PHPUnit installed and accessible via command line. There is a `mysql_testing` database defined within the app config which is what is used by PHPUnit. This database is set with the following database name, user name and password defined as `bookstack-test`. You will have to create that database and credentials before testing. 32 BookStack has many integration tests that use Laravel's built-in testing capabilities which makes use of PHPUnit. To use you will need PHPUnit installed and accessible via command line. There is a `mysql_testing` database defined within the app config which is what is used by PHPUnit. This database is set with the following database name, user name and password defined as `bookstack-test`. You will have to create that database and credentials before testing.
26 33
27 The testing database will also need migrating and seeding beforehand. This can be done with the following commands: 34 The testing database will also need migrating and seeding beforehand. This can be done with the following commands:
28 35
29 -``` 36 +``` bash
30 php artisan migrate --database=mysql_testing 37 php artisan migrate --database=mysql_testing
31 php artisan db:seed --class=DummyContentSeeder --database=mysql_testing 38 php artisan db:seed --class=DummyContentSeeder --database=mysql_testing
32 ``` 39 ```
33 40
34 Once done you can run `phpunit` in the application root directory to run all tests. 41 Once done you can run `phpunit` in the application root directory to run all tests.
35 42
43 +## Website and Docs
44 +
45 +The website and project docs are currently stored in the [BookStackApp/website](https://github.com/BookStackApp/website) repo. The docs are stored as markdown files in the `resources/docs` folder
46 +
36 ## License 47 ## License
37 48
38 BookStack is provided under the MIT License. 49 BookStack is provided under the MIT License.
...@@ -53,5 +64,11 @@ These are the great projects used to help build BookStack: ...@@ -53,5 +64,11 @@ These are the great projects used to help build BookStack:
53 * [TinyColorPicker](http://www.dematte.at/tinyColorPicker/index.html) 64 * [TinyColorPicker](http://www.dematte.at/tinyColorPicker/index.html)
54 * [Marked](https://github.com/chjj/marked) 65 * [Marked](https://github.com/chjj/marked)
55 * [Moment.js](http://momentjs.com/) 66 * [Moment.js](http://momentjs.com/)
67 +* [BarryVD](https://github.com/barryvdh)
68 + * [Debugbar](https://github.com/barryvdh/laravel-debugbar)
69 + * [Dompdf](https://github.com/barryvdh/laravel-dompdf)
70 + * [Snappy (WKHTML2PDF)](https://github.com/barryvdh/laravel-snappy)
71 + * [Laravel IDE helper](https://github.com/barryvdh/laravel-ide-helper)
72 +* [WKHTMLtoPDF](http://wkhtmltopdf.org/index.html)
56 73
57 Additionally, Thank you [BrowserStack](https://www.browserstack.com/) for supporting us and making cross-browser testing easy. 74 Additionally, Thank you [BrowserStack](https://www.browserstack.com/) for supporting us and making cross-browser testing easy.
......