A platform to create documentation/wiki content built with PHP & Laravel
PHP HTML JavaScript CSS
Permalink
Failed to load latest commit information.
.github Updated issue template and added TinyMCE autolinking Jan 16, 2017
app Added transclusion tests and fixed other tests Jan 21, 2017
bootstrap Updated all application urls to allow path prefix. Aug 14, 2016
config Added wkhtmltopdf support and done some style tweaks Jan 1, 2017
database Added options to use database cache & sessions Jan 21, 2017
public Updated pointer to be able to show includes Jan 21, 2017
resources Merge branch 'page_transclusion' Jan 21, 2017
routes Merge branch 'master' into translations Dec 31, 2016
storage Started work on attachments Oct 9, 2016
tests Added transclusion tests and fixed other tests Jan 21, 2017
.env.example Updated all application urls to allow path prefix. Aug 14, 2016
.gitattributes Initial commit Jul 12, 2015
.gitignore Added wkhtmltopdf support and done some style tweaks Jan 1, 2017
.travis.yml Updated CI to not use github token Jan 16, 2017
LICENSE Add in LICENSE file Jun 3, 2016
artisan Initial commit Jul 12, 2015
composer.json Added wkhtmltopdf support and done some style tweaks Jan 1, 2017
composer.lock Added wkhtmltopdf support and done some style tweaks Jan 1, 2017
gulpfile.js Updated build and versioning system Oct 30, 2016
package.json Updated pointer to be able to show includes Jan 21, 2017
phpunit.xml Extracted text from book & chapter views Nov 17, 2016
readme.md Added user setting system and added user-lang option Jan 15, 2017
server.php Initial commit Jul 12, 2015
version Updated build and versioning system Oct 30, 2016

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.

Translations

As part of BookStack v0.14 support for translations has been built in. All text strings can be found in the resources/lang folder where each language option has its own folder. To add a new language you should copy the en folder to an new folder (eg. fr for french) then go through and translate all text strings in those files, leaving the keys and file-names intact. If a language string is missing then the en translation will be used. To show the language option in the user preferences language drop-down you will need to add your language to the options found at the bottom of the resources/lang/en/settings.php file. A system-wide language can also be set in the .env file like so: APP_LANG=en.

Some strings have colon-prefixed variables in such as :userName. Leave these values as they are as they will be replaced at run-time.

Website, Docs & Blog

The website project docs & Blog can be found in the BookStackApp/website repo.

License

The BookStack source 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.