summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authormarudor <marudor@marudor.de>2018-05-03 17:33:49 +0200
committermarudor <marudor@marudor.de>2018-05-03 17:33:49 +0200
commitba4ab7dbc102c43a861654910ba33989021e9c8b (patch)
tree47ee466231e8596f986c702fc4b9624b8ca2a3d6 /README.md
parent757d87946931620cf5fe84ec5f163edd6f3986f8 (diff)
add documentation, include old custom font again
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index 418dc625..4a6211a2 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,8 @@ To report bugs use [engelsystem/issues](https://github.com/engelsystem/engelsyst
* PHP >= 7.0.0
* MySQL-Server >= 5.5 or MariaDB-Server >= 5.5
* Webserver, i.e. lighttpd, nginx, or Apache
+ * Node >= 8 (Development/Building only)
+ * Yarn (Development/Building only)
### Directions:
* Clone the master branch: `git clone https://github.com/engelsystem/engelsystem.git`
@@ -20,13 +22,20 @@ To report bugs use [engelsystem/issues](https://github.com/engelsystem/engelsyst
* Install project dependencies:
```bash
composer install
+ yarn
```
On production systems it is recommended to use
```bash
composer install --no-dev
composer dump-autoload --optimize
+
```
to install the engelsystem
+ * Build the frontend assets
+ ```bash
+ yarn build
+ ```
+
* The webserver must have write access to the ```import``` directory and read access for all other directories
* The webserver must point to the ```public``` directory.
* The webserver must read the ```.htaccess``` file and ```mod_rewrite``` must be enabled