Infra-Mirrors/BookStack
1
0
Fork 0
mirror of https://github.com/BookStackApp/BookStack.git synced 2024-10-01 01:36:00 -04:00
Code Issues Packages Projects Releases Wiki Activity
A platform to create documentation/wiki content built with PHP & Laravel
537 Commits 18 Branches 197 Tags 95 MiB
PHP 72.8%
TypeScript 18.4%
Blade 4.3%
JavaScript 3.2%
SCSS 1.3%
a323b0d49c
Go to file
Dan Brown a323b0d49c
Allowed child entity permissions to override parent permissions 
Updated elements of a page display and sidebar render to allow
child permissions to work even when parent entitites have permission
set. This allows a page with a 'view' permission to be viewable even
when the parent book or chapter is not viewable.

Fixes #366
2017-04-22 13:39:34 +01:00
.github Updated issue template and added TinyMCE autolinking 2017-01-16 19:33:29 +00:00
app Allowed child entity permissions to override parent permissions 2017-04-22 13:39:34 +01:00
bootstrap Updated all application urls to allow path prefix. 2016-08-14 12:29:35 +01:00
config Add APP_LOGGING 2017-04-17 09:55:11 +02:00
database Added page revision counting 2017-04-20 20:58:54 +01:00
public Migrated to custom gulp setup and conintue search interface 2017-04-14 18:47:33 +01:00
resources Allowed child entity permissions to override parent permissions 2017-04-22 13:39:34 +01:00
routes Added chapter search 2017-04-15 19:16:07 +01:00
storage Started work on attachments 2016-10-09 18:58:22 +01:00
tests Allowed child entity permissions to override parent permissions 2017-04-22 13:39:34 +01:00
.env.example Updated all application urls to allow path prefix. 2016-08-14 12:29:35 +01:00
.gitattributes Initial commit 2015-07-12 20:01:42 +01:00
.gitignore Migrated to custom gulp setup and conintue search interface 2017-04-14 18:47:33 +01:00
.travis.yml Fixed export testing and updated travis settings 2017-02-26 21:39:15 +00:00
artisan Initial commit 2015-07-12 20:01:42 +01:00
composer.json Set composer to clean bootstrap/cache before an update 2017-02-27 16:55:40 +00:00
composer.lock Updated DOMPDF to latest version 2017-02-25 14:59:56 +00:00
gulpfile.js Migrated to custom gulp setup and conintue search interface 2017-04-14 18:47:33 +01:00
LICENSE Add in LICENSE file 2016-06-03 18:51:47 +01:00
package.json Switched out markdown render 2017-04-17 12:21:10 +01:00
phpunit.xml Extracted text from book & chapter views 2016-11-17 13:33:07 +00:00
readme.md Switched out markdown render 2017-04-17 12:21:10 +01:00
server.php Initial commit 2015-07-12 20:01:42 +01:00
version Upgraded to Laravel 5.4 2017-01-25 19:35:40 +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.

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.

Contributing

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.

Pull requests are very welcome. If the scope of your pull request is very 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.

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.