github-mirror/BookStack
2
0
Fork 0
mirror of https://github.com/BookStackApp/BookStack.git synced 2024-11-24 07:09:05 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
A platform to create documentation/wiki content built with PHP & Laravel
359 Commits 20 Branches 198 Tags 65 MiB
PHP 72.9%
TypeScript 18.4%
Blade 4.3%
JavaScript 3.1%
SCSS 1.3%
781f0e7887
Go to file
Dan Brown 781f0e7887
Added draft save indicator and fixed notification positions
2016-09-02 19:26:12 +01:00
.github Changed issue template to use md extension 2016-07-26 17:46:09 +01:00
app Updated travis testing to work with new helper configuration (#175) 2016-08-27 11:27:23 +01:00
bootstrap Updated all application urls to allow path prefix. 2016-08-14 12:29:35 +01:00
config Updated all application urls to allow path prefix. 2016-08-14 12:29:35 +01:00
database edit summary 2016-07-07 20:53:43 +02:00
public Cleaned up tag edit interface 2016-05-14 20:02:00 +01:00
resources Added draft save indicator and fixed notification positions 2016-09-02 19:26:12 +01:00
storage Added tests for profile pages 2016-02-18 19:32:07 +00:00
tests Fixed single word quoted search terms 2016-08-25 17:17:26 +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 Tweaked page form header and added public uploads folder into repo 2016-02-07 10:21:09 +00:00
.travis.yml Updated travis testing to work with new helper configuration (#175) 2016-08-27 11:27:23 +01:00
artisan Initial commit 2015-07-12 20:01:42 +01:00
composer.json Updated all application urls to allow path prefix. 2016-08-14 12:29:35 +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 all application urls to allow path prefix. 2016-08-14 12:29:35 +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: