X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/30db8af460ad41cf4470b3fcee2cb4cffb28a807..refs/pull/2393/head:/readme.md diff --git a/readme.md b/readme.md index 5b51b8eab..bf6dfac2d 100644 --- a/readme.md +++ b/readme.md @@ -13,6 +13,8 @@ A platform for storing and organising information and documentation. Details for * [Demo Instance](https://demo.bookstackapp.com) * [Admin Login](https://demo.bookstackapp.com/login?email=admin@example.com&password=password) * [BookStack Blog](https://www.bookstackapp.com/blog) +* [Issue List](https://github.com/BookStackApp/BookStack/issues) +* [Discord Chat](https://discord.gg/ztkBqR2) ## 📚 Project Definition @@ -49,7 +51,7 @@ All development on BookStack is currently done on the master branch. When it's t * [Node.js](https://nodejs.org/en/) v10.0+ -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: +This project uses SASS for CSS development and this is built, along with the JavaScript, using a range of npm scripts. The below npm commands can be used to install the dependencies & run the build tasks: ``` bash # Install NPM Dependencies @@ -78,7 +80,7 @@ Once done you can run `php vendor/bin/phpunit` in the application root directory ### 📜 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. +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. Please don't auto-fix code unless it's related to changes you've made otherwise you'll likely cause git conflicts. ### 🐋 Development using Docker @@ -91,12 +93,11 @@ To get started, make sure you meet the following requirements: If all the conditions are met, you can proceed with the following steps: -1. Install PHP/Composer dependencies with **`docker-compose run app composer install`** (first time can take a while because the image has to be built). -2. **Copy `.env.example` to `.env`** and change `APP_KEY` to a random 32 char string. -3. Make sure **port 8080 is unused** *or else* change `DEV_PORT` to a free port on your host. -4. **Run `chgrp -R docker storage`**. The development container will chown the `storage` directory to the `www-data` user inside the container so BookStack can write to it. You need to change the group to your host's `docker` group here to not lose access to the `storage` directory. -5. **Run `docker-compose up`** and wait until all database migrations have been done. -6. You can now login with `admin@admin.com` and `password` as password on `localhost:8080` (or another port if specified). +1. **Copy `.env.example` to `.env`**, change `APP_KEY` to a random 32 char string and set `APP_ENV` to `local`. +2. Make sure **port 8080 is unused** *or else* change `DEV_PORT` to a free port on your host. +3. **Run `chgrp -R docker storage`**. The development container will chown the `storage` directory to the `www-data` user inside the container so BookStack can write to it. You need to change the group to your host's `docker` group here to not lose access to the `storage` directory. +4. **Run `docker-compose up`** and wait until the image is built and all database migrations have been done. +5. You can now login with `admin@admin.com` and `password` as password on `localhost:8080` (or another port if specified). If needed, You'll be able to run any artisan commands via docker-compose like so: @@ -118,7 +119,9 @@ Please note, translations in BookStack are provided to the "Crowdin Global Trans Feel free to create issues to request new features or to report bugs & problems. Just please follow the template given when creating the issue. -Pull requests are welcome. Unless a small tweak or language update, It may be best to open the pull request early or create an issue for your intended change to discuss how it will fit in to the project and plan out the merge. Pull requests should be created from the `master` branch since they will 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. +Pull requests are welcome. Unless a small tweak or language update, It may be best to open the pull request early or create an issue for your intended change to discuss how it will fit in to 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. + +Pull requests should be created from the `master` branch since they will 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. The project's code of conduct [can be found here](https://github.com/BookStackApp/BookStack/blob/master/.github/CODE_OF_CONDUCT.md). @@ -153,8 +156,7 @@ These are the great open-source projects used to help build BookStack: * [Laravel](http://laravel.com/) * [TinyMCE](https://www.tinymce.com/) * [CodeMirror](https://codemirror.net) -* [Vue.js](http://vuejs.org/) -* [Sortable](https://github.com/SortableJS/Sortable) & [Vue.Draggable](https://github.com/SortableJS/Vue.Draggable) +* [Sortable](https://github.com/SortableJS/Sortable) * [Google Material Icons](https://material.io/icons/) * [Dropzone.js](http://www.dropzonejs.com/) * [clipboard.js](https://clipboardjs.com/) @@ -165,6 +167,6 @@ These are the great open-source projects used to help build BookStack: * [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) +* [diagrams.net](https://github.com/jgraph/drawio) * [Laravel Stats](https://github.com/stefanzweifel/laravel-stats) -* [OneLogin's SAML PHP Toolkit](https://github.com/onelogin/php-saml) \ No newline at end of file +* [OneLogin's SAML PHP Toolkit](https://github.com/onelogin/php-saml)