# BookStack
-A platform to create documentation/wiki content. General information about BookStack can be found at https://www.bookstackapp.com/
+[](https://github.com/BookStackApp/BookStack/releases/latest)
+[](https://github.com/BookStackApp/BookStack/blob/master/LICENSE)
+[](https://travis-ci.org/BookStackApp/BookStack)
+A platform for storing and organising information and documentation. General information and documentation for BookStack can be found at https://www.bookstackapp.com/.
-## Requirements
+* [Installation Instructions](https://www.bookstackapp.com/docs/admin/installation)
+* [Documentation](https://www.bookstackapp.com/docs)
+* [Demo Instance](https://demo.bookstackapp.com)
+ * *Password: `password`*
+* [BookStack Blog](https://www.bookstackapp.com/blog)
-BookStack has similar requirements to Laravel. On top of those are some front-end build tools which are only required when developing.
+## Project Definition
-* PHP >= 5.5.9
-* OpenSSL PHP Extension
-* PDO PHP Extension
-* MBstring PHP Extension
-* Tokenizer PHP Extension
-* MySQL >= 5.6
-* Git (Not strictly required but helps manage updates)
-* [Composer](https://getcomposer.org/)
-* [Node.js](https://nodejs.org/en/) **Development Only**
-* [Gulp](http://gulpjs.com/) **Development Only**
+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.
-## Installation
+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.
-Ensure the requirements are met before installing.
+## Development & Testing
-Currently BookStack requires its own domain/subdomain and will not work in a site subdirectory.
+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:
-This project currently uses the `release` branch of this repository as a stable channel for providing updates.
+* [Node.js](https://nodejs.org/en/) v6.9+
-The installation is currently somewhat complicated and will be made simpler in future releases. Some PHP/Laravel experience will currently benefit.
+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:
-1. Clone the release branch of this repository into a folder.
+``` bash
+# Build assets for development
+npm run build
-```
-git clone https://github.com/ssddanbrown/BookStack.git --branch release --single-branch
+# Build and minify assets for production
+npm run production
+
+# Build for dev (With sourcemaps) and watch for changes
+npm run dev
```
-2. `cd` into the application folder and run `composer install`.
-3. Copy the `.env.example` file to `.env` and fill with your own database and mail details.
-4. Ensure the `storage` & `bootstrap/cache` folders are writable by the web server.
-5. In the application root, Run `php artisan key:generate` to generate a unique application key.
-6. If not using apache or if `.htaccess` files are disabled you will have to create some URL rewrite rules as shown below.
-7. Run `php artisan migrate` to update the database.
-8. Done! You can now login using the default admin details `
[email protected]` with a password of `password`. It is recommended to change these details directly after first logging in.
+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.
-#### URL Rewrite rules
+The testing database will also need migrating and seeding beforehand. This can be done with the following commands:
-**Apache**
+``` bash
+php artisan migrate --database=mysql_testing
+php artisan db:seed --class=DummyContentSeeder --database=mysql_testing
```
-Options +FollowSymLinks
-RewriteEngine On
-RewriteCond %{REQUEST_FILENAME} !-d
-RewriteCond %{REQUEST_FILENAME} !-f
-RewriteRule ^ index.php [L]
-```
+Once done you can run `phpunit` in the application root directory to run all tests.
-**Nginx**
-```
-location / {
- try_files $uri $uri/ /index.php?$query_string;
-}
-```
+## Translations
-## Testing
+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`.
-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.
+You will also need to add the language to the `locales` array in the `config/app.php` file.
-The testing database will also need migrating and seeding beforehand. This can be done with the following commands:
+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:
-```
-php artisan migrate --database=mysql_testing
-php artisan db:seed --class=DummyContentSeeder --database=mysql_testing
+```bash
+# Syntax
+php resources/lang/check.php <lang>
+
+# Examples
+php resources/lang/check.php fr
+php resources/lang/check.php pt_BR
```
-Once done you can run `phpunit` in the application root directory to run all tests.
+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](https://github.com/BookStackApp/BookStack/blob/master/.github/CODE_OF_CONDUCT.md).
+
+### Code Standards
+
+PHP code within BookStack is generally to [PSR-2](http://www.php-fig.org/psr/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](https://github.com/BookStackApp/website) repo.
## License
-BookStack is provided under the MIT License.
+The BookStack source is provided under the MIT License.
## Attribution
-These are the great projects used to help build BookStack:
+The great people that have worked to build and improve BookStack can [be seen here](https://github.com/BookStackApp/BookStack/graphs/contributors).
+
+These are the great open-source projects used to help build BookStack:
* [Laravel](http://laravel.com/)
-* [AngularJS](https://angularjs.org/)
* [jQuery](https://jquery.com/)
* [TinyMCE](https://www.tinymce.com/)
-* [highlight.js](https://highlightjs.org/)
+* [CodeMirror](https://codemirror.net)
+* [Vue.js](http://vuejs.org/)
+* [Axios](https://github.com/mzabriskie/axios)
* [jQuery Sortable](https://johnny.github.io/jquery-sortable/)
-* [Material Design Iconic Font](http://zavoloklom.github.io/material-design-iconic-font/icons.html)
+* [Google Material Icons](https://material.io/icons/)
* [Dropzone.js](http://www.dropzonejs.com/)
-* [ZeroClipboard](http://zeroclipboard.org/)
+* [clipboard.js](https://clipboardjs.com/)
+* [TinyColorPicker](http://www.dematte.at/tinyColorPicker/index.html)
+* [markdown-it](https://github.com/markdown-it/markdown-it) and [markdown-it-task-lists](https://github.com/revin/markdown-it-task-lists)
+* [Moment.js](http://momentjs.com/)
+* [BarryVD](https://github.com/barryvdh)
+ * [Debugbar](https://github.com/barryvdh/laravel-debugbar)
+ * [Dompdf](https://github.com/barryvdh/laravel-dompdf)
+ * [Snappy (WKHTML2PDF)](https://github.com/barryvdh/laravel-snappy)
+ * [Laravel IDE helper](https://github.com/barryvdh/laravel-ide-helper)
+* [WKHTMLtoPDF](http://wkhtmltopdf.org/index.html)
+* [Draw.io](https://github.com/jgraph/drawio)
projects / bookstack / blobdiff