luisgulo/BookStack
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
A platform to create documentation/wiki content built with PHP & Laravel
382 commits 15 branches 187 tags 105 MiB
PHP 89.1%
Blade 5.4%
JavaScript 4%
SCSS 1.5%
Find a file
Dan Brown 771626b6ec
Started work on making the public role/user configurable 
Create a new 'public' guest user and made the public
role visible on role setting screens.
2016-09-29 12:43:46 +01:00
.github Changed issue template to use md extension 2016-07-26 17:46:09 +01:00
app Started work on making the public role/user configurable 2016-09-29 12:43:46 +01:00
bootstrap Updated all application urls to allow path prefix. 2016-08-14 12:29:35 +01:00
config Added app name header display setting + extracted setting text 2016-09-22 18:53:22 +01:00
database Started work on making the public role/user configurable 2016-09-29 12:43:46 +01:00
public Updated TinyMCE version from 4.3.7 to 4.4.3 2016-09-06 19:29:09 +01:00
resources Started work on making the public role/user configurable 2016-09-29 12:43:46 +01:00
routes Separated revision preview and diff & fixed chosen diff html 2016-09-29 10:10:46 +01:00
storage Added tests for profile pages 2016-02-18 19:32:07 +00:00
tests Laravel 5.3 upgrade (#189) 2016-09-17 18:22:04 +01:00
.env.example Updated all application urls to allow path prefix. 2016-08-14 12:29:35 +01:00
.gitattributes
.gitignore Laravel 5.3 upgrade (#189) 2016-09-17 18:22:04 +01:00
.travis.yml Improved Exception handling, Removed npm requirement for testing 2016-09-03 12:08:58 +01:00
artisan
composer.json Merge branch 'diff' of git://github.com/younes0/BookStack into younes0-diff 2016-09-29 09:32:40 +01:00
composer.lock Merge branch 'diff' of git://github.com/younes0/BookStack into younes0-diff 2016-09-29 09:32:40 +01:00
gulpfile.js Added page HTML export 2016-01-20 22:13:13 +00:00
LICENSE Add in LICENSE file 2016-06-03 18:51:47 +01:00
package.json Updated elixr and fixed table th element borders 2016-08-13 10:02:54 +01:00
phpunit.xml Improved Exception handling, Removed npm requirement for testing 2016-09-03 12:08:58 +01:00
readme.md Updated all application urls to allow path prefix. 2016-08-14 12:29:35 +01:00
server.php

readme.md

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: