BookStack Code Mirror - bookstack/blob

1 # BookStack

3 [![GitHub release](https://img.shields.io/github/release/ssddanbrown/BookStack.svg?maxAge=2592000)](https://github.com/ssddanbrown/BookStack/releases/latest)

4 [![license](https://img.shields.io/github/license/ssddanbrown/BookStack.svg?maxAge=2592000)](https://github.com/ssddanbrown/BookStack/blob/master/LICENSE)

5 [![Build Status](https://travis-ci.org/BookStackApp/BookStack.svg)](https://travis-ci.org/BookStackApp/BookStack)

6

7 A platform for storing and organising information and documentation. General information and documentation for BookStack can be found at https://www.bookstackapp.com/.

8

9 * [Installation Instructions](https://www.bookstackapp.com/docs/admin/installation)

10 * [Documentation](https://www.bookstackapp.com/docs)

11 * [Demo Instance](https://demo.bookstackapp.com)

12 * *Username: `[email protected]`*

13 * *Password: `password`*

14 * [BookStack Blog](https://www.bookstackapp.com/blog)

15

16 ## Development & Testing

17

18 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:

19

20 * [Node.js](https://nodejs.org/en/) v6.9+

21

22 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:

23

24 ``` bash

25 # Build and minify for production

26 npm run-script build

27

28 # Build for dev (With sourcemaps) and watch for changes

29 npm run-script dev

30 ```

31

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

33

34 The testing database will also need migrating and seeding beforehand. This can be done with the following commands:

35

36 ``` bash

37 php artisan migrate --database=mysql_testing

38 php artisan db:seed --class=DummyContentSeeder --database=mysql_testing

39 ```

40

41 Once done you can run `phpunit` in the application root directory to run all tests.

42

43 ## Website and Docs

44

45 The website and project docs are currently stored in the [BookStackApp/website](https://github.com/BookStackApp/website) repo. The docs are stored as markdown files in the `resources/docs` folder

46

47 ## License

48

49 BookStack is provided under the MIT License.

50

51 ## Attribution

52

53 These are the great projects used to help build BookStack:

54

55 * [Laravel](http://laravel.com/)

56 * [AngularJS](https://angularjs.org/)

57 * [jQuery](https://jquery.com/)

58 * [TinyMCE](https://www.tinymce.com/)

59 * [highlight.js](https://highlightjs.org/)

60 * [jQuery Sortable](https://johnny.github.io/jquery-sortable/)

61 * [Material Design Iconic Font](http://zavoloklom.github.io/material-design-iconic-font/icons.html)

62 * [Dropzone.js](http://www.dropzonejs.com/)

63 * [ZeroClipboard](http://zeroclipboard.org/)

64 * [TinyColorPicker](http://www.dematte.at/tinyColorPicker/index.html)

65 * [Marked](https://github.com/chjj/marked)

66 * [Moment.js](http://momentjs.com/)

67 * [BarryVD](https://github.com/barryvdh)

68 * [Debugbar](https://github.com/barryvdh/laravel-debugbar)

69 * [Dompdf](https://github.com/barryvdh/laravel-dompdf)

70 * [Snappy (WKHTML2PDF)](https://github.com/barryvdh/laravel-snappy)

71 * [Laravel IDE helper](https://github.com/barryvdh/laravel-ide-helper)

72 * [WKHTMLtoPDF](http://wkhtmltopdf.org/index.html)

73

74 Additionally, Thank you [BrowserStack](https://www.browserstack.com/) for supporting us and making cross-browser testing easy.