BookStack Code Mirror - bookstack/blobdiff

index e048e8ea63663078e53dfaca590adea7f35f2681..e1c890e0b69e544998a071137d1b1b2be2947c27 100644 (file)

# BookStack

[![GitHub release](https://img.shields.io/github/release/BookStackApp/BookStack.svg)](https://github.com/BookStackApp/BookStack/releases/latest)

# BookStack

[![GitHub release](https://img.shields.io/github/release/BookStackApp/BookStack.svg)](https://github.com/BookStackApp/BookStack/releases/latest)

-[![license](https://img.shields.io/github/license/BookStackApp/BookStack.svg)](https://github.com/BookStackApp/BookStack/blob/master/LICENSE)

-[![Build Status](https://travis-ci.org/BookStackApp/BookStack.svg)](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/.

+[![license](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/BookStackApp/BookStack/blob/development/LICENSE)

+[![Crowdin](https://badges.crowdin.net/bookstack/localized.svg)](https://crowdin.com/project/bookstack)

+[![Build Status](https://github.com/BookStackApp/BookStack/workflows/test-php/badge.svg)](https://github.com/BookStackApp/BookStack/actions)

+[![Lint Status](https://github.com/BookStackApp/BookStack/workflows/lint-php/badge.svg)](https://github.com/BookStackApp/BookStack/actions)

+[![Maintainability](https://api.codeclimate.com/v1/badges/5551731994dd22fa1f4f/maintainability)](https://codeclimate.com/github/BookStackApp/BookStack/maintainability)

+<br>

+[![Alternate Source](https://img.shields.io/static/v1?label=Alt+Source&message=Git&color=ef391a&logo=git)](https://source.bookstackapp.com/)

+[![Repo Stats](https://img.shields.io/static/v1?label=GitHub+project&message=stats&color=f27e3f)](https://gh-stats.bookstackapp.com/)

+[![Discord](https://img.shields.io/static/v1?label=Discord&message=chat&color=738adb&logo=discord)](https://www.bookstackapp.com/links/discord)

+[![Mastodon](https://img.shields.io/static/v1?label=Mastodon&message=@bookstack&color=595aff&logo=mastodon)](https://www.bookstackapp.com/links/mastodon)

+<br>

+[![PeerTube](https://img.shields.io/static/v1?label=PeerTube&[email protected]&color=f2690d&logo=peertube)](https://foss.video/c/bookstack)

+[![YouTube](https://img.shields.io/static/v1?label=YouTube&message=bookstackapp&color=ff0000&logo=youtube)](https://www.youtube.com/bookstackapp)

+A platform for storing and organising information and documentation. Details for BookStack can be found on the official website at https://www.bookstackapp.com/.

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

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

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

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

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

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

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

- * *Password: `password`*

+ * [Admin Login](https://demo.bookstackapp.com/[email protected]&password=password)

+* [Screenshots](https://www.bookstackapp.com/#screenshots)

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

+* [Issue List](https://github.com/BookStackApp/BookStack/issues)

+* [Discord Chat](https://www.bookstackapp.com/links/discord)

+* [Support Options](https://www.bookstackapp.com/support/)

+## 📚 Project Definition

+BookStack is an opinionated documentation platform 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.

+In regard to development philosophy, BookStack has a relaxed, open & positive approach. We aim to slowly yet continuously evolve the platform while providing a stable & easy upgrade path.

+You can read more about the project and its origins in [our FAQ here](https://www.bookstackapp.com/about/project-faq/).

+## 🌟 Project Sponsors

+Shown below are our bronze, silver and gold project sponsors.

+Big thanks to these companies for supporting the project.

+*Note: The listed services are not tested, vetted nor supported by the official BookStack project in any manner.*

+[Project donation details](https://www.bookstackapp.com/donate/) - [GitHub Sponsors Page](https://github.com/sponsors/ssddanbrown) - [Ko-fi Page](https://ko-fi.com/ssddanbrown)

+#### Gold Sponsor

+<table><tbody><tr>

+<td align="center"><a href="https://www.federated.computer/bookstack-wiki" target="_blank">

+ <img width="480" src="https://www.bookstackapp.com/images/sponsors/federated-computer.png" alt="Federated.computer">

+</a></td>

+</tr></tbody></table>

+#### Bronze Sponsors

+<table><tbody><tr>

+<td align="center"><a href="https://www.diagrams.net/" target="_blank">

+ <img width="240" src="https://www.bookstackapp.com/images/sponsors/diagramsnet.png" alt="Diagrams.net">

+</a></td>

+<td align="center"><a href="https://cloudabove.com/hosting" target="_blank">

+ <img width="200" src="https://www.bookstackapp.com/images/sponsors/cloudabove.png" alt="Cloudabove">

+</a></td>

+</tr><tr>

+<td align="center"><a href="https://www.practicali.be" target="_blank">

+ <img width="240" src="https://www.bookstackapp.com/images/sponsors/practicali.png" alt="Practicali">

+</a></td>

+<td align="center"><a href="https://www.stellarhosted.com/bookstack/" target="_blank">

+ <img width="240" src="https://www.bookstackapp.com/images/sponsors/stellarhosted.png" alt="Stellar Hosted">

+</a></td>

+</tr>

+<tr>

+<td align="center" style="text-align: center"><a href="https://nws.netways.de/apps/bookstack/" target="_blank">

+ <img width="240" src="https://www.bookstackapp.com/images/sponsors/netways.png" alt="NETWAYS Web Services">

+</a></td>

+<td align="center" style="text-align: center"><a href="https://www.schroeck-consulting.de/" target="_blank">

+ <img width="200" src="https://www.bookstackapp.com/images/sponsors/schroeck-consulting.png" alt="Schroeck IT Consulting">

+</a></td>

+</tr>

+<tr>

+<td align="center"><a href="https://practinet.be/" target="_blank">

+ <img width="240" src="https://www.bookstackapp.com/images/sponsors/practinet.png" alt="Practinet">

+</a></td>

+<td align="center"><a href="https://route4me.com/" target="_blank">

+ <img width="240" src="https://www.bookstackapp.com/images/sponsors/route4me.png" alt="Route4Me - Route Optimizer and Route Planner Software">

+</a></td>

+</tr>

+<tr>

+<td colspan="2" align="center"><a href="https://phamos.eu" target="_blank">

+ <img width="136" src="https://www.bookstackapp.com/images/sponsors/phamos.png" alt="phamos">

+</a></td>

+</tr>

+</tbody></table>

+## 🛠️ Development & Testing

+Please see our [development docs](dev/docs/development.md) for full details regarding work on the BookStack source code.

+If you're just looking to customize or extend your own BookStack instance, take a look at our [Hacking BookStack documentation page](https://www.bookstackapp.com/docs/admin/hacking-bookstack/) for details on various options to achieve this without altering the BookStack source code.

+Details about BookStack's versioning scheme and the general release process [can be found here](dev/docs/release-process.md).

-## Project Definition

+## 🌎 Translations

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

+Translations for text within BookStack is managed through the [BookStack project on Crowdin](https://crowdin.com/project/bookstack). Some strings have colon-prefixed variables such as `:userName`. Leave these values as they are as they will be replaced at run-time.

-BookStack is not designed as an extensible platform to be used for purposes that differ to the statement above.

+Please use [Crowdin](https://crowdin.com/project/bookstack) to contribute translations instead of opening a pull request. The translations within the working codebase can be out-of-date, and merging via code can cause conflicts & sync issues. If for some reason you can't use Crowdin feel free to open an issue to discuss alternative options.

-## Development & Testing

+If you'd like a new language to be added to Crowdin, for you to be able to provide translations for, please [open a new issue here](https://github.com/BookStackApp/BookStack/issues/new?template=language_request.yml).

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

+Please note, translations in BookStack are provided to the "Crowdin Global Translation Memory" which helps BookStack and other projects with finding translations. If you are not happy with contributing to this then providing translations to BookStack, even manually via GitHub, is not advised.

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

+## 🎁 Contributing, Issues & Pull Requests

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

+Feel free to [create issues](https://github.com/BookStackApp/BookStack/issues/new/choose) to request new features or to report bugs & problems. Just please follow the template given when creating the issue.

-``` bash

-# Build assets for development

-npm run-script build

+Pull requests are welcome but, unless it's a small tweak, it may be best to open the pull request early or create an issue for your intended change to discuss how it will fit into the project and plan out the merge. Just because a feature request exists, or is tagged, does not mean that feature would be accepted into the core project.

-# Build and minify assets for production

-npm run-script production

+Pull requests should be created from the `development` branch since they will be merged back into `development` 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/`. Any CSS or JS files within `public` are built from these source files and therefore should not be edited directly.

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

-npm run-script dev

-```

+The project's code of conduct [can be found here](https://github.com/BookStackApp/BookStack/blob/development/.github/CODE_OF_CONDUCT.md).

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

+## 🔒 Security

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

+Security information for administering a BookStack instance can be found on the [documentation site here](https://www.bookstackapp.com/docs/admin/security/).

-``` bash

-php artisan migrate --database=mysql_testing

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

-```

+If you'd like to be notified of new potential security concerns you can [sign-up to the BookStack security mailing list](https://updates.bookstackapp.com/signup/bookstack-security-updates).

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

+If you would like to report a security concern, details of doing so [can be found here](https://github.com/BookStackApp/BookStack/blob/development/.github/SECURITY.md).

-## Translations

+## ♿ Accessibility

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

+We want BookStack to remain accessible to as many people as possible. We aim for at least WCAG 2.1 Level A standards where possible although we do not strictly test this upon each release. If you come across any accessibility issues please feel free to open an issue.

-You will also need to add the language to the `locales` array in the `config/app.php` file.

- 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

+## 🖥️ Website, Docs & Blog

-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 website which contains the project docs & blog can be found in the [BookStackApp/website](https://codeberg.org/bookstack/website) repo.

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

+## ⚖️ License

-## Website, Docs & Blog

+The BookStack source is provided under the [MIT License](https://github.com/BookStackApp/BookStack/blob/development/LICENSE).

-The website project docs & Blog can be found in the [BookStackApp/website](https://github.com/BookStackApp/website) repo.

+The libraries used by, and included with, BookStack are provided under their own licenses and copyright.

+The licenses for many of our core dependencies can be found in the attribution list below but this is not an exhaustive list of all projects used within BookStack.

-## License

+## 👪 Attribution

-The BookStack source is provided under the MIT License.

+The great people that have worked to build and improve BookStack can [be seen here](https://github.com/BookStackApp/BookStack/graphs/contributors). The wonderful people that have provided translations, either through GitHub or via Crowdin [can be seen here](https://github.com/BookStackApp/BookStack/blob/development/.github/translators.txt).

-## Attribution

+Below are the great open-source projects used to help build BookStack.

+Note: This is not an exhaustive list of all libraries and projects that would be used in an active BookStack instance.

-These are the great open-source projects used to help build BookStack:

+* [Laravel](http://laravel.com/) - _[MIT](https://github.com/laravel/framework/blob/v8.82.0/LICENSE.md)_

+* [TinyMCE](https://www.tinymce.com/) - _[MIT](https://github.com/tinymce/tinymce/blob/develop/LICENSE.TXT)_

+* [Lexical](https://lexical.dev/) - _[MIT](https://github.com/facebook/lexical/blob/main/LICENSE)_

+* [CodeMirror](https://codemirror.net) - _[MIT](https://github.com/codemirror/CodeMirror/blob/master/LICENSE)_

+* [Sortable](https://github.com/SortableJS/Sortable) - _[MIT](https://github.com/SortableJS/Sortable/blob/master/LICENSE)_

+* [Google Material Icons](https://github.com/google/material-design-icons) - _[Apache-2.0](https://github.com/google/material-design-icons/blob/master/LICENSE)_

+* [markdown-it](https://github.com/markdown-it/markdown-it) and [markdown-it-task-lists](https://github.com/revin/markdown-it-task-lists) - _[MIT](https://github.com/markdown-it/markdown-it/blob/master/LICENSE) and [ISC](https://github.com/revin/markdown-it-task-lists/blob/master/LICENSE)_

+* [Dompdf](https://github.com/dompdf/dompdf) - _[LGPL v2.1](https://github.com/dompdf/dompdf/blob/master/LICENSE.LGPL)_

+* [KnpLabs/snappy](https://github.com/KnpLabs/snappy) - _[MIT](https://github.com/KnpLabs/snappy/blob/master/LICENSE)_

+* [WKHTMLtoPDF](http://wkhtmltopdf.org/index.html) - _[LGPL v3.0](https://github.com/wkhtmltopdf/wkhtmltopdf/blob/master/LICENSE)_

+* [diagrams.net](https://github.com/jgraph/drawio) - _[Embedded Version Terms](https://www.diagrams.net/trust/) / [Source Project - Apache-2.0](https://github.com/jgraph/drawio/blob/dev/LICENSE)_

+* [SAML PHP Toolkit](https://github.com/SAML-Toolkits/php-saml) - _[MIT](https://github.com/SAML-Toolkits/php-saml/blob/master/LICENSE)_

+* [League/CommonMark](https://commonmark.thephpleague.com/) - _[BSD-3-Clause](https://github.com/thephpleague/commonmark/blob/2.2/LICENSE)_

+* [League/Flysystem](https://flysystem.thephpleague.com) - _[MIT](https://github.com/thephpleague/flysystem/blob/3.x/LICENSE)_

+* [League/html-to-markdown](https://github.com/thephpleague/html-to-markdown) - _[MIT](https://github.com/thephpleague/html-to-markdown/blob/master/LICENSE)_

+* [League/oauth2-client](https://oauth2-client.thephpleague.com/) - _[MIT](https://github.com/thephpleague/oauth2-client/blob/master/LICENSE)_

+* [pragmarx/google2fa](https://github.com/antonioribeiro/google2fa) - _[MIT](https://github.com/antonioribeiro/google2fa/blob/8.x/LICENSE.md)_

+* [Bacon/BaconQrCode](https://github.com/Bacon/BaconQrCode) - _[BSD-2-Clause](https://github.com/Bacon/BaconQrCode/blob/master/LICENSE)_

+* [phpseclib](https://github.com/phpseclib/phpseclib) - _[MIT](https://github.com/phpseclib/phpseclib/blob/master/LICENSE)_

+* [Clockwork](https://github.com/itsgoingd/clockwork) - _[MIT](https://github.com/itsgoingd/clockwork/blob/master/LICENSE)_

+* [PHPStan](https://phpstan.org/) & [Larastan](https://github.com/nunomaduro/larastan) - _[MIT](https://github.com/phpstan/phpstan/blob/master/LICENSE) and [MIT](https://github.com/nunomaduro/larastan/blob/master/LICENSE.md)_

+* [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) - _[BSD 3-Clause](https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt)_

+* [JakeArchibald/IDB-Keyval](https://github.com/jakearchibald/idb-keyval) - _[Apache-2.0](https://github.com/jakearchibald/idb-keyval/blob/main/LICENCE)_

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

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

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

-* [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)

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

-* [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)

+For a detailed breakdown of the JavaScript & PHP projects imported & used via NPM & composer package managers, along with their licenses, please see the [dev/licensing/js-library-licenses.txt](dev/licensing/js-library-licenses.txt) and [dev/licensing/php-library-licenses.txt](dev/licensing/php-library-licenses.txt) files.

\ No newline at end of file