chiu
/
filebrowser
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

Create CONTRIBUTING.md 

Former-commit-id: 9a0b7f42558604211f1209c78b45476c80613ffb [formerly 0418a1c0690581069c4749c794d44f87da82298e] [formerly d46e205f0349a58c33538437dba8a716d7212b73 [formerly 9d9eaf03a363372d62852055265af33721917640]]
Former-commit-id: 72538667e655928cc4b460ae3fb458780578bb71 [formerly caa99ae829c154ad1e4ec8f69b9e4c5d1e51be77]
Former-commit-id: 9cf73b9b63a8c80f0dd26b1307e6c7a8eb6152a0
This commit is contained in:
Henrique Dias 2017-07-28 14:33:49 +01:00 committed by GitHub
parent 7ce9c72dc5
commit ae860e5bfc
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,14 @@
# Contributing
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:
1. `go get github.com/hacdias/filemanager`
2. `cd $GOPATH/src/github.com/hacdias/filemanager`
3. `npm install`
4. `npm run dev` - regenerates the static assets automatically
5. `go install github.com/hacdias/filemanager/cmd/filemanager`
6. Execute `$GOPATH/bin/filemanager`
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`.