https://github.com/appwrite-community/offline-journal
Private journal with offline-sync capabilities
https://github.com/appwrite-community/offline-journal
appwrite journal offline-sync pwa rxdb svelte sveltekit
Last synced: 2 months ago
JSON representation
Private journal with offline-sync capabilities
- Host: GitHub
- URL: https://github.com/appwrite-community/offline-journal
- Owner: appwrite-community
- Created: 2025-04-08T15:35:41.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2026-01-16T17:19:25.000Z (5 months ago)
- Last Synced: 2026-01-17T05:36:43.647Z (5 months ago)
- Topics: appwrite, journal, offline-sync, pwa, rxdb, svelte, sveltekit
- Language: Svelte
- Homepage: https://offline-journal.appwrite.network
- Size: 1.68 MB
- Stars: 9
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Offline Journal
A private journaling application built with Svelte and RxDB that lets you write and store your thoughts offline. Your entries are stored locally with cloud sync capabilities through Appwrite.
## Features
- ✍️ Create, edit, and manage journal entries
- 💾 Offline-first approach using RxDB for local storage
- 🔄 Cloud sync with Appwrite
- 🔐 Privacy-focused - all data stays on your device by default
- 🔑 Secure authentication with magic email links
- 📱 Responsive design that works on all devices
- ⚡ Fast and lightweight
- 🎯 Clean and intuitive interface
## Technical Stack
- **Frontend**: Svelte 5 with SvelteKit
- **Database**: RxDB with IndexedDB adapter (via Dexie.js)
- **Cloud Sync**: Appwrite backend
- **Build Tool**: Vite
## Development
1. Clone the repository
2. Install dependencies:
```bash
npm install
```
3. Configure Environment Variables:
- Copy `.env.example` to `.env`
- Update the `.env` file with your Appwrite project details:
```
PUBLIC_APPWRITE_ENDPOINT=your-appwrite-endpoint
PUBLIC_APPWRITE_PROJECT_ID=your-project-id
PUBLIC_APPWRITE_DATABASE_ID=your-database-id
PUBLIC_APPWRITE_COLLECTION_ID=your-collection-id
```
4. Start the development server:
```bash
npm run dev
# or start the server and open the app in a new browser tab
npm run dev -- --open
```
## Building
To create a production version of the app:
```bash
npm run build
```
You can preview the production build with `npm run preview`.
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
MIT License