https://github.com/ghall89/whiskerdb

A browser-based, local-first personal database app
https://github.com/ghall89/whiskerdb

database dexie-cloud indexdb local-first nextjs typescript

Last synced: 7 days ago
JSON representation

A browser-based, local-first personal database app

• Host: GitHub
• URL: https://github.com/ghall89/whiskerdb
• Owner: ghall89
• License: mit
• Created: 2024-11-17T22:08:57.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-12-27T01:49:42.000Z (7 days ago)
• Last Synced: 2024-12-27T02:38:37.066Z (7 days ago)
• Topics: database, dexie-cloud, indexdb, local-first, nextjs, typescript
• Language: TypeScript
• Homepage:
• Size: 313 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# WhiskerDB 🐱

![GitHub License](https://img.shields.io/github/license/ghall89/whiskerdb) ![GitHub top language](https://img.shields.io/github/languages/top/ghall89/WhiskerDB)

## About

WhiskerDB is a web-based, local-first, personal database application, built with NextJS and powered by Dexie.

## Getting Started

Follow these steps from the project directory.

1. Install dependencies `pnpm install`

2. Run `npx dexie-cloud create` to setup the sync server. You will be prompted for email verification, afterwards your database's URL will be printed to the terminal, and saved to a new file called `dexie-cloud.json`

3. You will have to whitelist your apps origin with `npx dexie-cloud whitelist http://localhost:3000`

4. Create an `.env.local` file, and add `DEXIE_CLOUD_URL=https://.dexie.cloud` to it

5. Run `pnpm dev`

## Documentation

_Work in progress 🏗_

## Dexie Cloud

Learn more about Dexie Cloud [here](https://dexie.org/cloud/)