mirror of
https://github.com/tmlnv/obsidian-telegram-bridge.git
synced 2026-07-22 06:53:13 +00:00
.gitignore readme.md package.json
This commit is contained in:
parent
c8dccad640
commit
fc477edebf
3 changed files with 65 additions and 2 deletions
9
.gitignore
vendored
Normal file
9
.gitignore
vendored
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
node_modules/
|
||||
dist/
|
||||
.DS_Store
|
||||
.env
|
||||
.env.*
|
||||
plugin/main.js
|
||||
plugin/node_modules/
|
||||
plugin/coverage/
|
||||
supabase/.temp/
|
||||
42
README.md
42
README.md
|
|
@ -1,2 +1,40 @@
|
|||
# obsidian-telegram
|
||||
Connector between obsidian and telegram via Supabase.
|
||||
# Obsidian Telegram
|
||||
|
||||
Telegram-to-Obsidian sync plugin with a Supabase backend.
|
||||
|
||||
This repository is a monorepo for:
|
||||
- the Obsidian plugin in `plugin/`
|
||||
- Supabase schema and Edge Functions in `supabase/`
|
||||
- setup and verification scripts in `scripts/`
|
||||
- planning docs in `docs/`
|
||||
|
||||
## Repository Layout
|
||||
|
||||
```text
|
||||
obsidian-telegram/
|
||||
├── plugin/
|
||||
├── supabase/
|
||||
├── scripts/
|
||||
└── docs/
|
||||
```
|
||||
|
||||
## Current Status
|
||||
|
||||
The repository is scaffolded for the revised architecture:
|
||||
- server-side Telegram webhook storage
|
||||
- per-client cursor sync, not global message sync flags
|
||||
- topic-aware routing
|
||||
- self-hosted Supabase bootstrap from one repo
|
||||
|
||||
## Quick Start
|
||||
|
||||
1. Run `npm run verify`.
|
||||
2. Configure Supabase CLI and project credentials.
|
||||
3. Run `npm run bootstrap:supabase`.
|
||||
4. Install plugin dependencies with `npm install --prefix plugin`.
|
||||
5. Build the plugin with `npm run build:plugin`.
|
||||
|
||||
## Notes
|
||||
|
||||
- The plugin scaffold follows the official Obsidian sample plugin structure, adapted to live in `plugin/`.
|
||||
- The implementation plan for this repo is in [docs/plans/2026-03-03-telegram-sync-server-revised.md](docs/plans/2026-03-03-telegram-sync-server-revised.md).
|
||||
|
|
|
|||
16
package.json
Normal file
16
package.json
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
{
|
||||
"name": "obsidian-telegram",
|
||||
"version": "0.1.0",
|
||||
"private": true,
|
||||
"description": "Monorepo for the Obsidian Telegram plugin and Supabase backend",
|
||||
"scripts": {
|
||||
"verify": "node scripts/verify-local-env.mjs",
|
||||
"bootstrap:supabase": "node scripts/bootstrap-supabase.mjs",
|
||||
"build:plugin": "npm run build --prefix plugin",
|
||||
"dev:plugin": "npm run dev --prefix plugin",
|
||||
"test:plugin": "npm run test --prefix plugin"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=20"
|
||||
}
|
||||
}
|
||||
Loading…
Reference in a new issue