-## Laravel PHP Framework
+# BookStack
-[](https://travis-ci.org/laravel/framework)
-[](https://packagist.org/packages/laravel/framework)
-[](https://packagist.org/packages/laravel/framework)
-[](https://packagist.org/packages/laravel/framework)
-[](https://packagist.org/packages/laravel/framework)
+[](https://github.com/ssddanbrown/BookStack/releases/latest)
+[](https://github.com/ssddanbrown/BookStack/blob/master/LICENSE)
+[](https://travis-ci.org/ssddanbrown/BookStack)
-Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable, creative experience to be truly fulfilling. Laravel attempts to take the pain out of development by easing common tasks used in the majority of web projects, such as authentication, routing, sessions, queueing, and caching.
+A platform for storing and organising information and documentation. General information and documentation for BookStack can be found at https://www.bookstackapp.com/.
-Laravel is accessible, yet powerful, providing powerful tools needed for large, robust applications. A superb inversion of control container, expressive migration system, and tightly integrated unit testing support give you the tools you need to build any application with which you are tasked.
+* [Installation Instructions](https://www.bookstackapp.com/docs/admin/installation)
+* [Documentation](https://www.bookstackapp.com/docs)
+* [Demo Instance](https://demo.bookstackapp.com) *(Login username: `
[email protected]`. Password: `password`)*
+* [BookStack Blog](https://www.bookstackapp.com/blog)
-## Official Documentation
+## Development & Testing
-Documentation for the framework can be found on the [Laravel website](http://laravel.com/docs).
+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:
-## Contributing
+* [Node.js](https://nodejs.org/en/)
+* [Gulp](http://gulpjs.com/)
-Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](http://laravel.com/docs/contributions).
+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.
-## Security Vulnerabilities
+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.
-If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell at
[email protected]. All security vulnerabilities will be promptly addressed.
+The testing database will also need migrating and seeding beforehand. This can be done with the following commands:
-### License
+```
+php artisan migrate --database=mysql_testing
+php artisan db:seed --class=DummyContentSeeder --database=mysql_testing
+```
-The Laravel framework is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)
+Once done you can run `phpunit` (or `./vendor/bin/phpunit` if `phpunit` is not found) in the application root directory to run all tests.
+
+## 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/)
projects / bookstack / blobdiff