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
232 Commits 18 Branches 197 Tags 95 MiB
PHP 72.8%
TypeScript 18.4%
Blade 4.3%
JavaScript 3.2%
SCSS 1.3%
ef874712bb
Go to file
Dan Brown ef874712bb Cut readme down and added useful links 
Remove a lot of the instructions/config info since much of it is now on the BookStack docs site.
2016-03-25 15:17:04 +00:00
app Fixed bug causing permission error on save and fixed non-gallery image save 2016-03-13 15:37:46 +00:00
bootstrap Change application namespace to BookStack 2015-09-10 19:31:09 +01:00
config Made memcached config allow mulitple servers 2016-03-05 09:47:24 +00:00
database Attached images to pages and added restriction filtering 2016-03-13 13:30:47 +00:00
public Forced browser scrollbar, Added custom theme compatible logo 2016-03-13 14:00:24 +00:00
resources Forced browser scrollbar, Added custom theme compatible logo 2016-03-13 14:00:24 +00:00
storage Added tests for profile pages 2016-02-18 19:32:07 +00:00
tests Fixed bug causing editing notification to always show 2016-03-13 14:33:43 +00:00
.env.example Made memcached config allow mulitple servers 2016-03-05 09:47:24 +00: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
artisan Initial commit 2015-07-12 20:01:42 +01:00
composer.json Added plaintext & basic PDF page Export 2016-01-31 17:53:30 +00:00
composer.lock Started work on user profile pages 2016-02-16 21:25:11 +00:00
gulpfile.js Added page HTML export 2016-01-20 22:13:13 +00:00
package.json Moved all vuejs parts over to angular 2015-12-30 18:38:18 +00:00
phpspec.yml Change application namespace to BookStack 2015-09-10 19:31:09 +01:00
phpunit.xml Added restriction tests and fixed any bugs in the process 2016-03-05 18:09:21 +00:00
readme.md Cut readme down and added useful links 2016-03-25 15:17:04 +00:00
server.php Initial commit 2015-07-12 20:01:42 +01:00

readme.md

BookStack

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: