aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: e49e6bc371427c1555d6339562a74b0b66f0bf80 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
### Cerrado

Self host single user mail based forge.

### Goals

Keep it simple and lightweight, that includes the application itself,
development process and the deployment.

The application requires no javascript to run, and it is light and fast to
render.

This project is also easy to iterate on. There are only two dev dependencies: go
and sassc so it compiles fast. Codewise it strives for easy to understand.
Easy to read code is better than clever.

The deployment process should be easy to wrap the head around and
straightforward to set up. To achieve that it uses a simple file format[^1] to
configure everything. Also to reduce the moving parts the whole application,
including its statics file, is bundled into a single binary.

To run the project you just need to do a make run.

### TODO

- Add path to tree view
    - Fix href with extra slash
- Add message to tags
- Add link to tar browser from commit page
- Add patch to the commit page
- Add log pagination
- Add tag pagination

### Milestone
- Mail patch / mailing list
- Code snippet support
- Setup manual (man feature perhaps?)
- Add authentication
    - Enforce public property
- Add metrics

[^1]: https://git.sr.ht/~emersion/scfg