1### Cerrado
 2
 3Self host single user mail based forge.
 4
 5### Goals
 6
 7Keep it simple and lightweight, that includes the application itself,
 8development process and the deployment.
 9
10The application requires no javascript to run, and it is light and fast to
11render.
12
13This project is also easy to iterate on. There are only two dev dependencies: go
14and sassc so it compiles fast. Codewise it strives for easy to understand.
15Easy to read code is better than clever.
16
17The deployment process should be easy to wrap the head around and
18straightforward to set up. To achieve that it uses a simple file format[^1] to
19configure everything. Also to reduce the moving parts the whole application,
20including its statics file, is bundled into a single binary.
21
22To run the project you just need to do a make run.
23
24### TODO
25
26- Add patch to the commit page
27- Add log pagination
28- Fix submodule link on tree view
29
30### Milestone
31- Mail patch / mailing list
32- Code snippet support
33- Setup manual (man feature perhaps?)
34- Add authentication
35    - Enforce public property
36- Add metrics
37- Add reference based cache system. Cerrado should be able to cache the whole
38  page based on its reference hash.
39
40[^1]: https://git.sr.ht/~emersion/scfg