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
251 commits 15 branches 187 tags 105 MiB
PHP 89.1%
Blade 5.4%
JavaScript 4%
SCSS 1.5%
Find a file
Dan Brown 6e03078de3 Started work towards adding role view permissions 
Work halted as re-write required.
In reference to #92
2016-04-09 12:40:07 +01:00
app Started work towards adding role view permissions 2016-04-09 12:40:07 +01:00
bootstrap
config Added Redis cache/session support 2016-04-03 11:00:14 +01:00
database Started work towards adding role view permissions 2016-04-09 12:40:07 +01:00
public Added a markdown editor 2016-03-25 14:41:15 +00:00
resources Started work towards adding role view permissions 2016-04-09 12:40:07 +01:00
storage Added tests for profile pages 2016-02-18 19:32:07 +00:00
tests Updated tests to match recent email confirmation changes 2016-04-03 12:34:10 +01:00
.env.example Made memcached config allow mulitple servers 2016-03-05 09:47:24 +00:00
.gitattributes
.gitignore Tweaked page form header and added public uploads folder into repo 2016-02-07 10:21:09 +00:00
artisan
composer.json Added Redis cache/session support 2016-04-03 11:00:14 +01:00
composer.lock Updated composer dependancies 2016-04-09 10:56:10 +01:00
gulpfile.js
package.json Added a markdown editor 2016-03-25 14:41:15 +00:00
phpspec.yml
phpunit.xml Added restriction tests and fixed any bugs in the process 2016-03-05 18:09:21 +00:00
readme.md Merge pull request #84 from ssddanbrown/markdown_editor 2016-03-29 20:18:11 +01:00
server.php

readme.md

BookStack

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: