From d87a8ee5ed3b041272f77a9e7ae5bcfcef9d0e85 Mon Sep 17 00:00:00 2001 From: Henrique Dias Date: Thu, 27 Jul 2017 14:30:40 +0100 Subject: [PATCH] Update README.md Former-commit-id: f5d3de7a867ec129722eb713c96dc3c1a2dbd29d [formerly 13041237112a88c32a576965470f26829ef09e76] [formerly 1ec2ac3a1cb4ed8f851073c44bd1910478fe6600 [formerly bcd1f57836c332cb13e0f528db5d08dcaf7973fb]] Former-commit-id: 6ef873900c9a33aa180966237c801a540beaae3f [formerly 933ca735ad2ebb87dfbcd32c59b84586a962bf5c] Former-commit-id: 85b221326e049dc2fd976681a5e93b0f01d1d8fd --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 0517fb51..a2459ee6 100644 --- a/README.md +++ b/README.md @@ -127,18 +127,19 @@ this are keywords case:insensitive # Contributing -If you want to contribute or want to build the code from source, you will need to have NodeJS and Go installed on your computer. You should start by doing the following: +If you want to contribute or want to build the code from source, you will need to have the most recent version of Go and, if you want to change the static assets (JS, CSS, ...), Node.js installed on your computer. To start developing, you just need to do the following: -``` -go get github.com/hacdias/filemanager -``` +1. `go get github.com/hacdias/filemanager` +2. `cd $GOPATH/src/github.com/hacdias/filemanager` +3. `npm install` +4. `npm start dev` - regenerates the static assets automatically +5. `go install gihthub.com/hacdias/filemanager/cmd/filemanager` +6. Execute `$GOPATH/bin/filemanager` -Then, you should navigate to `$GOPATH/src/github.com/hacdias/filemanager` and execute `npm install`. You can start the live build of static assets with the command `npm start dev`. +The steps 3 and 4 are only required **if you want to develop the front-end**. Otherwise, you can ignore them. Before pulling, if you made any change on assets folder, you must run the `build.sh` script on the root of this repository. If you are using this as a Caddy plugin, you should use its [official instructions for plugins](https://github.com/mholt/caddy/wiki/Extending-Caddy#2-plug-in-your-plugin) and import `github.com/hacdias/filemanager/caddy/filemanager`. -Before pulling, and if you made any change on assets folder, you must run the `build.sh` script on the root of this repository. - # Donate Enjoying this project? You can [donate to its creator](https://henriquedias.com/donate/). He will appreciate.