1### Cerrado
 2
 3Self host single user mail based forge.
 4
 5You can find a running instance here:
 6
 7https://beta.gabrielgio.me
 8
 9### Goals
10
11Keep it simple and lightweight, that includes the application itself,
12development process and the deployment.
13
14The application requires no javascript to run, and it is light and fast to
15render.
16
17This project is also easy to iterate on. There are only two dev dependencies: go
18and sassc so it compiles fast. Codewise it strives for easy to understand.
19Easy to read code is better than clever.
20
21The deployment process should be easy to wrap the head around and
22straightforward to set up. To achieve that it uses a simple file format[^1] to
23configure everything. Also to reduce the moving parts the whole application,
24including its statics file, is bundled into a single binary.
25
26To run the project you just need to do a make run.
27
28### Installations
29
30The only installation process available so far is through my apk
31repository[^2][^3].
32
33You can check openrc files for the details how it is run, but in general you'd
34need the cerrado binary and scfg file. I can easily be integration with
35systemd.
36
37### Contributing
38
39To discuss about the project send me a email or write an issue on codeberg[^4].
40To avoid duplicated work or to work something I might not take in, I'd
41recommend to reach me before doing something.
42
43To contribute code feel free to create a PR on codeberg or send me an
44email-patch[^5].
45
46My email:
47
48mail@gabrielgio.me
49
50### TODO
51
52- Impove diff display
53- Add log pagination
54
55### Milestone
56- Mail patch / mailing list
57- Code snippet support
58- Setup manual (man feature perhaps?)
59- Add authentication
60    - Enforce public property
61- Add metrics
62- Add reference based cache system. Cerrado should be able to cache the whole
63  page based on its reference hash.
64
65[^1]: https://git.sr.ht/~emersion/scfg
66[^2]: https://apkdoc.gabrielgio.me/
67[^3]: https://git.gabrielgio.me/apkbuilds/
68[^4]: https://codeberg.org/gabrielgio/cerrado/issues
69[^5]: https://git-send-email.io/