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
333 commits 15 branches 187 tags 105 MiB
PHP 89.1%
Blade 5.4%
JavaScript 4%
SCSS 1.5%
Find a file
Dan Brown baa260a03d Started work on subdirectory support
2016-08-13 17:56:25 +01:00
app Started work on subdirectory support 2016-08-13 17:56:25 +01:00
bootstrap Change application namespace to BookStack 2015-09-10 19:31:09 +01:00
config Started work on subdirectory support 2016-08-13 17:56:25 +01:00
database Added checks to use MyISAM if MySQL 5.5 is found 2016-06-04 16:32:57 +01:00
public Cleaned up tag edit interface 2016-05-14 20:02:00 +01:00
resources Started work on subdirectory support 2016-08-13 17:56:25 +01:00
storage Added tests for profile pages 2016-02-18 19:32:07 +00:00
tests Fixed entities created with blank slugs. 2016-08-13 13:53:04 +01:00
.env.example Made memcached config allow mulitple servers 2016-03-05 09:47:24 +00:00
.gitattributes Initial commit 2015-07-12 20:01:42 +01:00
.gitignore Tweaked page form header and added public uploads folder into repo 2016-02-07 10:21:09 +00:00
.travis.yml Travis CI updates (#130) 2016-06-19 19:30:43 +01:00
artisan Initial commit 2015-07-12 20:01:42 +01:00
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 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
phpspec.yml Change application namespace to BookStack 2015-09-10 19:31:09 +01:00
phpunit.xml Updated social testing compatibility 2016-05-02 11:26:47 +01:00
readme.md Updated License file 2016-06-03 18:52:49 +01:00
server.php Initial commit 2015-07-12 20:01:42 +01:00

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: