Contributing
Last updated
Was this helpful?
Last updated
Was this helpful?
If you're interested in contributing to this project, this is the best place to start. Before contributing to this project, please take a bit of time to read our . Also, note that this project is open-source and licensed under .
The project is mainly composed by one , hosted on GitHub. The backend side of the application is written in , while the frontend (located on a subdirectory of the same name) is written in , a framework to produce , and .
Due to the tight coupling required by some features, basic knowledge of both Go and Vue.js is recommended.
Learn Go:
Learn Vue.js:
We encourage you to use git to manage your fork. To clone the main repository, just run:
We are using on the frontend to manage the build process. The steps to build it are:
This will install the dependencies and build the frontend so you can then embed it into the Go app. Although, if you want to play with it, you'll get bored of building it after every change you do. So, you can run the command below to watch for changes:
First of all, you need to download the required dependencies. We are using the built-in go mod
tool for dependency management. To get the modules, run:
To build File Browser is just like any other Go program:
To create a development build use the "dev" tag, this way the content inside the frontend folder will not be embedded in the binary but will be reloaded at every change:
The magic of File Browser is that the static assets are bundled into the final binary. For that, we use . The files from frontend/dist
will be embedded during the build process.