Documentation

BageBook technical documentation

This page is an index of the verified public documentation for the current repository.

Introduction

BageBook is a React and Vite single-page web application for journaling, notes, and writing. Read the project overview.

Architecture

The app is served by Express, uses React Router for authenticated application routes, IndexedDB for local persistence, and Firebase Auth and Firestore for signed-in synchronization.

Privacy and security

Private user paths are protected by Firestore ownership rules. Optional content encryption is described in the security architecture.

Offline functionality

Local writes use IndexedDB. When offline, operations are placed in a pending queue and processed when connectivity returns.

Storage

Authenticated user databases use user-scoped IndexedDB names. Cloud data is stored in the configured Firebase Firestore database according to the repository rules.

Development

Clone the repository, install Node.js dependencies with npm install, run npm run dev, and use npm run build for a production build.

Further reading

Features · Security · FAQ · Changelog · Source code

Contribution guidance, a formal license, and a complete release history are not currently declared in the repository.