Coffee journaling on ATProto (alpha)
alpha.arabica.social
coffee
docs: update README
+18
-31
+18
-30
README.md
+18
-30
README.md
···
37
37
38
38
Access at http://localhost:18910
39
39
40
-
## Docker
41
-
42
-
```bash
43
-
# Build and run with Docker Compose
44
-
docker compose up -d
45
-
46
-
# Or build and run manually
47
-
docker build -t arabica .
48
-
docker run -p 18910:18910 -v arabica-data:/data arabica
49
-
```
50
-
51
-
For production deployments, configure environment variables in `docker-compose.yml`:
52
-
53
-
```yaml
54
-
environment:
55
-
- SERVER_PUBLIC_URL=https://arabica.example.com
56
-
- SECURE_COOKIES=true
57
-
```
58
-
59
40
## Configuration
60
41
61
42
### Command-Line Flags
···
75
56
- `LOG_LEVEL` - Logging level: debug, info, warn, error (default: info)
76
57
- `LOG_FORMAT` - Log format: console, json (default: console)
77
58
78
-
## Architecture
79
-
80
-
Data is stored in AT Protocol records on users' Personal Data Servers. The application uses OAuth to authenticate with the PDS and performs all CRUD operations via the AT Protocol API.
81
-
82
-
Local BoltDB stores:
83
-
84
-
- OAuth session data
85
-
- Feed registry (list of DIDs for community feed)
86
-
87
-
See docs/ for detailed documentation.
88
-
89
59
## Development
60
+
61
+
With Nix:
90
62
91
63
```bash
92
64
# Enter development environment
···
101
73
# Build
102
74
go build -o arabica cmd/server/main.go
103
75
```
76
+
77
+
Without Nix, you'll need to have Go, Templ, and tailwindcss installed (just is optional but recommended).
78
+
79
+
```sh
80
+
# Generate CSS files
81
+
tailwindcss -i static/css/app.css -o static/css/output.css --minify
82
+
# Compile Templ
83
+
templ generate
84
+
# Run the appview
85
+
go run cmd/server/main.go
86
+
87
+
# with just
88
+
just run
89
+
```
90
+
91
+
---
104
92
105
93
## Deployment
106
94
-1
justfile
-1
justfile
···
3
3
4
4
run:
5
5
@LOG_LEVEL=debug LOG_FORMAT=console ARABICA_MODERATORS_CONFIG=roles.json go run cmd/server/main.go -known-dids known-dids.txt
6
-
# @bash scripts/run.sh
7
6
8
7
templ-watch:
9
8
@templ generate --watch --proxy="http://localhost:18080" --cmd="go run ./cmd/server -known-dids known-dids.txt"