The project is live on https://ciphernotes.com

F-Droid Version: https://f-droid.org/en/packages/com.ciphernotes.twa/

The notes are encrypted before being sent to the server, but the encryption key is stored in the browser's local storage. This way no password is needed to access the notes and they key can easily be shared between devices. You can share the key via a QR code directly from app to app.

You can self-host the project using Docker Compose. See the dockerimage/README.md for more details.

• nvm (node version manager)
• Docker (for development database)
• Bun (for backend)
• Yarn (for frontend)
• mkcert (for generating development certificates)

docker compose up minio-setup

1. Start the PostgreSQL database:

   docker-compose up -d postgres

   This will start the PostgreSQL database on port 5432.

1. Navigate to the backend directory:

   cd backend

2. Copy the environment file:

   cp .env.example .env

3. Install dependencies:

   bun install

4. generate jwt key

openssl genpkey -algorithm RSA -out jwt-private.pem -pkeyopt rsa_keygen_bits:2048
openssl rsa -pubout -in jwt-private.pem -out ../frontend/jwt-public.pub

5. Initialize the database schema:

   bun db:migrate    # Apply schema changes

6. Start the backend:

   bun dev

1. Install mkcert (if not already installed):

   • Windows (with chocolatey): choco install mkcert
   • macOS (with homebrew): brew install mkcert
   • Linux: Check your package manager or visit https://github.com/FiloSottile/mkcert

2. Install local CA:

   mkcert -install

3. Navigate to the frontend directory:

   cd frontend

4. Generate certificates for localhost:

   mkcert -key-file key.pem -cert-file cert.pem localhost 127.0.0.1 ::1

   This will create two files:

   • cert.pem: SSL certificate (trusted by your system)
   • key.pem: Private key

1. Navigate to the frontend directory (if not already there):

   cd frontend

2. Install node

   nvm install
   nvm use

3. Install dependencies:

   yarn install

4. Start the frontend development server:

   yarn dev

• Frontend: https://localhost:5173
• Backend API: http://localhost:5100
• PostgreSQL: localhost:5432
• MinIO: localhost:9000
• MinIO Console: localhost:9001

• Frontend: React + TypeScript + Vite
• Backend: Bun + TypeScript
• Server: express-zod-api
• Database: PostgreSQL 16
• ORM: Drizzle

1. Find your computer's local IP address:

   ipconfig # Windows
   ifconfig | grep 'inet ' | grep -v 127.0.0.1 # macOS/Linux

2. Generate new certificates including your IP:

   mkcert -key-file key.pem -cert-file cert.pem localhost 127.0.0.1 ::1 <your-ip>

3. Start the frontend:

   yarn dev

4. Find and install the root CA certificate on your mobile device:

   mkcert -CAROOT

   This shows the folder containing rootCA.pem
5. Access https://<your-ip>:5173 on your mobile device

~\.bubblewrap\jdk\jdk-17.0.11+9\bin\keytool.exe -genkeypair -alias com.ciphernotes.twa -keyalg RSA \
 -keysize 2048 -validity 10000 -keystore android.keystore

~\.bubblewrap\jdk\jdk-17.0.11+9\bin\keytool.exe -printcert -jarfile ".\app-release-signed.apk"

From the frontend/ directory you can run yarn build:twa to compile the web app and copy the generated assets into twa/app/src/main/assets/www.

The source in this repository (frontend, backend, infrastructure, and Android App) is released under the terms of the AGPL-3.0-only license; see LICENSE for the full text. Third-party components remain under their respective licenses. Review individual package documentation for complete notices when redistributing.