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
445 commits 15 branches 187 tags 105 MiB
PHP 89.1%
Blade 5.4%
JavaScript 4%
SCSS 1.5%
Find a file
Dan Brown 969ad8911c
Updated page nav to hide when empty
2017-01-14 15:34:52 +00:00
.github Changed issue template to use md extension 2016-07-26 17:46:09 +01:00
app Updated page nav to hide when empty 2017-01-14 15:34:52 +00:00
bootstrap Updated all application urls to allow path prefix. 2016-08-14 12:29:35 +01:00
config Added wkhtmltopdf support and done some style tweaks 2017-01-01 12:20:30 +00:00
database Fixed image delete permission issue 2017-01-08 19:19:30 +00:00
public Updated build and versioning system 2016-10-30 17:44:00 +00:00
resources Updated page nav to hide when empty 2017-01-14 15:34:52 +00:00
routes Merge branch 'master' into translations 2016-12-31 14:32:52 +00:00
storage Started work on attachments 2016-10-09 18:58:22 +01:00
tests Fixed image delete permission issue 2017-01-08 19:19:30 +00:00
.env.example Updated all application urls to allow path prefix. 2016-08-14 12:29:35 +01:00
.gitattributes
.gitignore Added wkhtmltopdf support and done some style tweaks 2017-01-01 12:20:30 +00:00
.travis.yml Improved Exception handling, Removed npm requirement for testing 2016-09-03 12:08:58 +01:00
artisan
composer.json Added wkhtmltopdf support and done some style tweaks 2017-01-01 12:20:30 +00:00
composer.lock Added wkhtmltopdf support and done some style tweaks 2017-01-01 12:20:30 +00:00
gulpfile.js Updated build and versioning system 2016-10-30 17:44:00 +00:00
LICENSE Add in LICENSE file 2016-06-03 18:51:47 +01:00
package.json Updated readme attribution and npm scripts 2017-01-01 12:51:23 +00:00
phpunit.xml Extracted text from book & chapter views 2016-11-17 13:33:07 +00:00
readme.md Updated readme attribution and npm scripts 2017-01-01 12:51:23 +00:00
server.php
version Updated build and versioning system 2016-10-30 17:44:00 +00: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. To run the build task you can use the following commands:

# Build and minify for production
npm run-script build

# Build for dev (With sourcemaps) and watch for changes
npm run-script dev

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 in the application root directory to run all tests.

Website and Docs

The website and project docs are currently stored in the BookStackApp/website repo. The docs are stored as markdown files in the resources/docs folder

License

BookStack is provided under the MIT License.

Attribution

These are the great projects used to help build BookStack:

Additionally, Thank you BrowserStack for supporting us and making cross-browser testing easy.