diff --git a/package.json b/package.json index 30f288d45..ec5911b93 100644 --- a/package.json +++ b/package.json @@ -1,8 +1,9 @@ { "private": true, "scripts": { - "prod": "gulp --production", - "dev": "gulp watch" + "build": "gulp --production", + "dev": "gulp watch", + "watch": "gulp watch" }, "devDependencies": { "angular": "^1.5.5", diff --git a/readme.md b/readme.md index 5d3e79a2e..fa5c48fe0 100644 --- a/readme.md +++ b/readme.md @@ -17,22 +17,33 @@ A platform for storing and organising information and documentation. General inf 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: -* [Node.js](https://nodejs.org/en/) -* [Gulp](http://gulpjs.com/) +* [Node.js](https://nodejs.org/en/) v6.9+ -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. +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: + +``` bash +# Build and minify for production +npm run-script build + +# Build for dev (With sourcemaps) and watch for changes +npm run-script dev +``` 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. The testing database will also need migrating and seeding beforehand. This can be done with the following commands: -``` +``` bash php artisan migrate --database=mysql_testing php artisan db:seed --class=DummyContentSeeder --database=mysql_testing ``` Once done you can run `phpunit` in the application root directory to run all tests. +## Website and Docs + +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 + ## License BookStack is provided under the MIT License. @@ -53,5 +64,11 @@ These are the great projects used to help build BookStack: * [TinyColorPicker](http://www.dematte.at/tinyColorPicker/index.html) * [Marked](https://github.com/chjj/marked) * [Moment.js](http://momentjs.com/) +* [BarryVD](https://github.com/barryvdh) + * [Debugbar](https://github.com/barryvdh/laravel-debugbar) + * [Dompdf](https://github.com/barryvdh/laravel-dompdf) + * [Snappy (WKHTML2PDF)](https://github.com/barryvdh/laravel-snappy) + * [Laravel IDE helper](https://github.com/barryvdh/laravel-ide-helper) +* [WKHTMLtoPDF](http://wkhtmltopdf.org/index.html) Additionally, Thank you [BrowserStack](https://www.browserstack.com/) for supporting us and making cross-browser testing easy.