BookStack/readme.md

# BookStack

[![GitHub release](https://img.shields.io/github/release/ssddanbrown/BookStack.svg?maxAge=2592000)](https://github.com/ssddanbrown/BookStack/releases/latest)
[![license](https://img.shields.io/github/license/ssddanbrown/BookStack.svg?maxAge=2592000)](https://github.com/ssddanbrown/BookStack/blob/master/LICENSE)
[![Build Status](https://travis-ci.org/ssddanbrown/BookStack.svg)](https://travis-ci.org/ssddanbrown/BookStack)

A platform for storing and organising information and documentation. General information and documentation for BookStack can be found at https://www.bookstackapp.com/.

* [Installation Instructions](https://www.bookstackapp.com/docs/admin/installation)
* [Documentation](https://www.bookstackapp.com/docs)
* [Demo Instance](https://demo.bookstackapp.com) *(Login username: `admin@example.com`. Password: `password`)*
* [BookStack Blog](https://www.bookstackapp.com/blog)

## Development & Testing

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/)

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.

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:

```
php artisan migrate --database=mysql_testing
php artisan db:seed --class=DummyContentSeeder --database=mysql_testing
```

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/)
Started working on chapters 2015-07-27 21:17:08 +02:00			`# BookStack`
Initial commit 2015-07-12 21:01:42 +02:00
Added licence and release badges 2016-06-03 19:50:20 +02:00			`[![GitHub release](https://img.shields.io/github/release/ssddanbrown/BookStack.svg?maxAge=2592000)](https://github.com/ssddanbrown/BookStack/releases/latest)`
Updated License file 2016-06-03 19:52:49 +02:00			`[![license](https://img.shields.io/github/license/ssddanbrown/BookStack.svg?maxAge=2592000)](https://github.com/ssddanbrown/BookStack/blob/master/LICENSE)`
Added dependancy caching and travis badge 2016-05-02 13:37:58 +02:00			`[![Build Status](https://travis-ci.org/ssddanbrown/BookStack.svg)](https://travis-ci.org/ssddanbrown/BookStack)`

Cut readme down and added useful links Remove a lot of the instructions/config info since much of it is now on the BookStack docs site. 2016-03-25 16:17:04 +01:00			`A platform for storing and organising information and documentation. General information and documentation for BookStack can be found at https://www.bookstackapp.com/.`
Updated readme with more details 2015-11-21 19:49:29 +01:00
Cut readme down and added useful links Remove a lot of the instructions/config info since much of it is now on the BookStack docs site. 2016-03-25 16:17:04 +01:00			`* [Installation Instructions](https://www.bookstackapp.com/docs/admin/installation)`
			`* [Documentation](https://www.bookstackapp.com/docs)`
			* [Demo Instance](https://demo.bookstackapp.com) (Login username: `admin@example.com`. Password: `password`)
			`* [BookStack Blog](https://www.bookstackapp.com/blog)`
Increased LDAP testing and fixed any Auth-based bugs found 2016-01-17 16:20:07 +01:00
Updated app requirements & Added some friendlier errors 2016-02-03 21:52:25 +01:00			`## Development & Testing`

			`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:`

Cut readme down and added useful links Remove a lot of the instructions/config info since much of it is now on the BookStack docs site. 2016-03-25 16:17:04 +01:00			`* [Node.js](https://nodejs.org/en/)`
			`* [Gulp](http://gulpjs.com/)`
Updated app requirements & Added some friendlier errors 2016-02-03 21:52:25 +01:00
			`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.`
Added further tests, Fixed speed_update issues, improved search result query count 2015-11-29 18:33:25 +01:00
			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:`

			```
			`php artisan migrate --database=mysql_testing`
			`php artisan db:seed --class=DummyContentSeeder --database=mysql_testing`
			```

Updated readme with social & update instructions 2016-01-02 17:24:09 +01:00			Once done you can run `phpunit` (or `./vendor/bin/phpunit` if `phpunit` is not found) in the application root directory to run all tests.
Updated readme with more details 2015-11-21 19:49:29 +01:00
			`## License`

			`BookStack is provided under the MIT License.`
Updated readme with fixes and attribution 2015-12-16 15:54:29 +01:00
			`## Attribution`

			`These are the great projects used to help build BookStack:`

			`* [Laravel](http://laravel.com/)`
Swapped vue for angular js 2015-12-31 18:32:03 +01:00			`* [AngularJS](https://angularjs.org/)`
Updated readme with fixes and attribution 2015-12-16 15:54:29 +01:00			`* [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/)`
Changed color picker library and moved color logic to front end Since the old library was GPLv3 i changed the color picker to tiny-color-picker which is MIT. Also extracted the styles to a shared view and move color calculation logic to javascript side. 2016-03-06 11:52:10 +01:00			`* [TinyColorPicker](http://www.dematte.at/tinyColorPicker/index.html)`
Added a markdown editor 2016-03-25 15:41:15 +01:00			`* [Marked](https://github.com/chjj/marked)`
Updated all application urls to allow path prefix. Allows BookStack to be installed at a non-root location on a domain. Closes #40. 2016-08-14 13:29:35 +02:00			`* [Moment.js](http://momentjs.com/)`