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- Impove diff display
27- Add log pagination
28
29### Milestone
30- Mail patch / mailing list
31- Code snippet support
32- Setup manual (man feature perhaps?)
33- Add authentication
34 - Enforce public property
35- Add metrics
36- Add reference based cache system. Cerrado should be able to cache the whole
37 page based on its reference hash.
38
39[^1]: https://git.sr.ht/~emersion/scfg