aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authornsfisis <nsfisis@gmail.com>2025-07-13 14:49:59 +0900
committernsfisis <nsfisis@gmail.com>2025-07-13 14:49:59 +0900
commit4082bdf34beda81815a41c8ce71086bed1c401cf (patch)
treecfc3493ef51e01203b7392157e295844a687189a /README.md
parentafdc7b9c3ba38c652ed407d6f844c548c9a8b4a8 (diff)
downloadfeedaka-4082bdf34beda81815a41c8ce71086bed1c401cf.tar.gz
feedaka-4082bdf34beda81815a41c8ce71086bed1c401cf.tar.zst
feedaka-4082bdf34beda81815a41c8ce71086bed1c401cf.zip
chore: add README
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bc2517b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# feedaka
+
+A simple RSS/Atom feed reader. This is my personal project and is developed for my use only.
+
+## Requirements
+
+* Go 1.24+
+* Node.js 22+
+* Docker and Docker Compose
+* [Just](https://github.com/casey/just)
+
+## Run
+
+### Docker
+
+```bash
+$ docker compose up
+```
+
+Access at <http://localhost:8002>.
+
+### Non-docker
+
+```bash
+$ just build
+$ cd frontend && npm run dev &
+$ cd .. && just serve
+``` \ No newline at end of file