A platform to create documentation/wiki content built with PHP & Laravel
Find a file
Dan Brown 7215392784 Changed when revisions are saved and update changelog input
Revisions are now saved when te page content is originally saved whereas before they were saved on the next update to the page.
2016-07-10 12:12:52 +01:00
app Changed when revisions are saved and update changelog input 2016-07-10 12:12:52 +01:00
bootstrap
config Fixed theme color elements not showing on new instance 2016-06-12 13:37:15 +01:00
database edit summary 2016-07-07 20:53:43 +02:00
public Cleaned up tag edit interface 2016-05-14 20:02:00 +01:00
resources Changed when revisions are saved and update changelog input 2016-07-10 12:12:52 +01:00
storage
tests Fixed error on image deletion 2016-07-01 20:13:30 +01:00
.env.example
.gitattributes
.gitignore
.travis.yml Travis CI updates (#130) 2016-06-19 19:30:43 +01:00
artisan
composer.json
composer.lock
gulpfile.js
LICENSE Add in LICENSE file 2016-06-03 18:51:47 +01:00
package.json Cleaned up tag edit interface 2016-05-14 20:02:00 +01:00
phpspec.yml
phpunit.xml
readme.md Updated License file 2016-06-03 18:52:49 +01:00
server.php

BookStack

GitHub release license Build Status

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

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:

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: