# BookStack
-A platform to create documentation/wiki content. General information about BookStack can be found at https://www.bookstackapp.com/
+[](https://github.com/ssddanbrown/BookStack/releases/latest)
+[](https://github.com/ssddanbrown/BookStack/blob/master/LICENSE)
+[](https://travis-ci.org/BookStackApp/BookStack)
-**BookStack is currently in rapid development so use now is heavily cautioned as future updates my break existing installations.**
+A platform for storing and organising information and documentation. General information and documentation for BookStack can be found at https://www.bookstackapp.com/.
-## Requirements
+* [Installation Instructions](https://www.bookstackapp.com/docs/admin/installation)
+* [Documentation](https://www.bookstackapp.com/docs)
+* [Demo Instance](https://demo.bookstackapp.com)
+ * *Password: `password`*
+* [BookStack Blog](https://www.bookstackapp.com/blog)
-BookStack has the similar requirements to Laravel. On top of those are some front-end build tools which the requirement of will be removed once out of beta release.
+## Development & Testing
-* PHP >= 5.5.9
-* OpenSSL PHP Extension
-* PDO PHP Extension
-* Mbstring PHP Extension
-* Tokenizer PHP Extension
-* MySQL >= 5.6
-* [Composer](https://getcomposer.org/)
-* [Node.js](https://nodejs.org/en/) **To be removed in future**
-* [Bower](http://bower.io/) **To be removed in future**
-* [Gulp](http://gulpjs.com/) **To be removed in future**
+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/) v6.9+
-## Installation
+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:
-Ensure the requirements are met before installing.
+``` bash
+# Build and minify for production
+npm run-script build
-The installation is currently somewhat complicated. Some PHP/Laravel experience will benefit. This will be streamlined in the future.
-
-1. Clone the repository into a folder.
-2. `cd` into folder and run `composer install` followed by `npm install` and `bower install`.
-3. Run `gulp --production` to compile the JavaScript and css files.
-4. Copy the `.env.example` file to `.env` and fill with your own database and mail details.
-5. Ensure the `storage` & `bootstrap/cache` folders are writable by the web server.
-5. In the application root, Run `php artisan key:generate` to generate a unique application key.
-6. If not using apache or `.htaccess` files are disable you will have to create some URL rewrite rules as shown below.
-7. Run `php migrate` to update the database.
-8. Done! You can now login using the default admin details `
[email protected]` with a password of `password`. It is recommended to change these details directly after first logging in.
-
-#### URL Rewrite rules
-
-**Apache**
+# Build for dev (With sourcemaps) and watch for changes
+npm run-script dev
```
-Options +FollowSymLinks
-RewriteEngine On
-
-RewriteCond %{REQUEST_FILENAME} !-d
-RewriteCond %{REQUEST_FILENAME} !-f
-RewriteRule ^ index.php [L]
-```
-
-**Nginx**
-```
-location / {
- try_files $uri $uri/ /index.php?$query_string;
-}
-```
-
-## Testing
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.
+
+## Attribution
+
+These are the great projects used to help build BookStack:
+
+* [Laravel](http://laravel.com/)
+* [AngularJS](https://angularjs.org/)
+* [jQuery](https://jquery.com/)
+* [TinyMCE](https://www.tinymce.com/)
+* [highlight.js](https://highlightjs.org/)
+* [jQuery Sortable](https://johnny.github.io/jquery-sortable/)
+* [Material Design Iconic Font](http://zavoloklom.github.io/material-design-iconic-font/icons.html)
+* [Dropzone.js](http://www.dropzonejs.com/)
+* [ZeroClipboard](http://zeroclipboard.org/)
+* [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.
projects / bookstack / blobdiff