itsscb/filebrowser
1
0
Fork 0
mirror of https://github.com/filebrowser/filebrowser.git synced 2025-05-08 11:22:10 +00:00
Code Issues Packages Projects Releases 1 Wiki Activity
filebrowser/CONTRIBUTING.md
Henrique Dias 7447a530ee Close #289 
Former-commit-id: 6145bac21a69ec5af8b0c9d6f5a343ab66c32c74 [formerly 13a045c4cc6852e88af60b359653032590c8cb48] [formerly 1b279454432546ba44702b792ec83eec00f63a1f [formerly b1c36ec71f42018153333ecd8407441422a5adec]]
Former-commit-id: ef359bdf00c3c64d4877f02de3d8cb505bd6448c [formerly b4f09c805cd6a0f5300a1e608d024ce7af6b60db]
Former-commit-id: 009fb85389f234e1d5f7fc726e1d983fed3b5832
2017-12-06 22:30:49 +00:00

1.0 KiB
Raw Blame History

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/cmd/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 and import github.com/hacdias/filemanager/caddy/filemanager.