A platform to create documentation/wiki content built with PHP & Laravel
PHP HTML JavaScript CSS
ssddanbrown Merge pull request #957 from moucho/master
Updated Spanish translation
Latest commit 01260d9 Aug 12, 2018
Permalink
Failed to load latest commit information.
.github Tweaked bug report template to request hosting method Aug 12, 2018
app Fixed incorrect type error in LDAP group sync Aug 12, 2018
bootstrap Fixed heavy init breakages made in last commit Nov 19, 2017
config Added option to disable public lang autodetect Aug 12, 2018
database Added ability to set custom ldap group -> role mapping Jul 15, 2018
public Updated the TinyMCE to version 4.7.9. Apr 14, 2018
resources Updated Spanish translation Aug 12, 2018
routes Merge branch 'drawing_updates' May 27, 2018
storage Added ability to secure images behind auth Jan 13, 2018
tests Added test to cover new language autodetect config option Aug 12, 2018
themes Added view override support Dec 31, 2017
.browserslistrc Added browserlist, Tweaked md scrollToText ot use ES6 Jul 14, 2018
.env.example Merge pull request #904 from lommes/903-socialite-discord Jul 29, 2018
.gitattributes Initial commit Jul 12, 2015
.gitignore Refactored moment.js out of app Apr 1, 2018
.travis.yml Fixed heavy init breakages made in last commit Nov 19, 2017
LICENSE Updated readme, license and added code of conduct Mar 25, 2018
artisan Fixed heavy init breakages made in last commit Nov 19, 2017
composer.json Updated composer dependancies Aug 12, 2018
composer.lock Updated composer dependancies Aug 12, 2018
package-lock.json Updated packages via npm audit Jul 28, 2018
package.json Updated packages via npm audit Jul 28, 2018
phpcs.xml Set /app PHP code to PSR-2 standard Jan 28, 2018
phpunit.xml Added test to cover new language autodetect config option Aug 12, 2018
readme.md Fixed licence badge Apr 22, 2018
server.php Initial commit Jul 12, 2015
version Updated version for next block of development Apr 30, 2018
webpack.config.js Added browserlist, Tweaked md scrollToText ot use ES6 Jul 14, 2018

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/.

Project Definition

BookStack is an opinionated wiki system that provides a pleasant and simple out of the box experience. New users to an instance should find the experience intuitive and only basic word-processing skills should be required to get involved in creating content on BookStack. The platform should provide advanced power features to those that desire it but they should not interfere with the core simple user experience.

BookStack is not designed as an extensible platform to be used for purposes that differ to the statement above.

In regards to development philosophy, BookStack has a relaxed, open & positive approach. Put simply, At the end of the day this is free software developed and maintained by people donating their own free time.

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 its version. Here are the current development requirements:

SASS is used to help the CSS development and the JavaScript is run through babel to allow for writing ES6 code. This is done using webpack. To run the build task you can use the following commands:

# Build assets for development
npm run build

# Build and minify assets for production
npm run production

# Build for dev (With sourcemaps) and watch for changes
npm run 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.

You will also need to add the language to the locales array in the config/app.php file.

There is a script available which compares translation content to en files to see what items are missing or redundant. This can be ran like so from your BookStack install folder:

# Syntax
php resources/lang/check.php <lang>

# Examples
php resources/lang/check.php fr
php resources/lang/check.php pt_BR

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

Contributing & Maintenence

Feel free to create issues to request new features or to report bugs and problems. Just please follow the template given when creating the issue.

The project's code of conduct can be found here.

Code Standards

PHP code within BookStack is generally to PSR-2 standards. From the BookStack root folder you can run ./vendor/bin/phpcs to check code is formatted correctly and ./vendor/bin/phpcbf to auto-fix non-PSR-2 code.

Pull Requests

Pull requests are very welcome. If the scope of your pull request is large it may be best to open the pull request early or create an issue for it to discuss how it will fit in to the project and plan out the merge.

Pull requests should be created from the master branch and should be merged back into master once done. Please do not build from or request a merge into the release branch as this is only for publishing releases.

If you are looking to alter CSS or JavaScript content please edit the source files found in resources/assets. Any CSS or JS files within public are built from these source files and therefore should not be edited directly.

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

The great people that have worked to build and improve BookStack can be seen here.

These are the great open-source projects used to help build BookStack: