GitBook: [master] 2 pages modified

Author: hacdias

contributing/builds.md

@@ -1,2 +1,25 @@
 # Builds
 
+## Get the source code
+
+In order to make development easier, the frontend is included in the backend as a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules). Then, in order to tinker with the sources, start by getting both repos at once with:
+
+```bash
+git clone --recurse-submodules https://github.com/filebrowser/filebrowser
+```
+
+{% hint style="info" %}
+Since it is a submodule, when developing the frontend remember to update the backend repository accordingly.
+{% endhint %}
+
+Alternatively, you can download the repositories in two steps with `curl`/`wget`:
+
+```bash
+curl -L https://github.com/filebrowser/filebrowser/archive/master.tar.gz | tar xvz
+cd filebrowser-master
+curl -L https://github.com/filebrowser/frontend/archive/master.tar.gz | tar xvz
+mv frontend-master frontend
+```
+
+However, note that this approach won't let you push your changes back easily.
+

contributing/project-structure.md

@@ -1,2 +1,18 @@
 # Project Structure
 
+This project is composed of two main repositories, both hosted at GitHub:
+
+* The [**backend**](https://github.com/filebrowser/filebrowser)**,** which is entirely written in [Go](https://golang.org/).
+* The [**frontend**](https://github.com/filebrowser/frontend), which is written in [Vue.js](https://vuejs.org/), a framework to produce [JavaScript](https://en.wikipedia.org/wiki/JavaScript), [CSS](https://en.wikipedia.org/wiki/Cascading_Style_Sheets) and [HTML](https://www.w3.org/html/).
+
+This modular approach is meant to make contributing easier for users willing to focus on/reuse only some piece, instead of being forced to analyze the whole project. However, due to the tight coupling required by some features, basic knowledge of both Go and Vue.js is recommended.
+
+* Learn Go: [https://github.com/golang/go/wiki/Learn](https://github.com/golang/go/wiki/Learn)
+* Learn Vue.js: [https://vuejs.org/v2/guide/index.html](https://vuejs.org/v2/guide/index.html)
+
+This structure is also valuable for third parties to develop alternative implementations of any of the pieces. E.g. a different frontend can be written using Angular, but keeping the same backend. Equally, a different backend can be written using Python or Ruby, but keeping the same frontend.
+
+
+
+
+