dnote/CONTRIBUTING.md

Contributing to Dnote

Dnote is an open source project.

• Setting up
• Server
• Command Line Interface

Setting up

The CLI and server are single single binary files with SQLite embedded - no databases to install, no containers to run, no VMs required.

Prerequisites

• Go 1.25+ (Download)
• Node.js 18+ (Download - only needed for building frontend assets)

Quick Start

1. Clone the repository
2. Install dependencies:

   make install
   

3. Start developing! Run tests:

   make test
   

   Or start the dev server:

   make dev-server
   

That's it. You're ready to contribute.

Server

# Start dev server (runs on localhost:3000)
make dev-server

# Run tests
make test-api

# Run tests in watch mode
WATCH=true make test-api

Command Line Interface

# Run tests
make test-cli

# Build dev version (places in your PATH)
make debug=true build-cli

# Build production version for all platforms
make version=v0.1.0 build-cli

# Build for a specific platform
# Note: You cannot cross-compile using this method because Dnote uses CGO
# and requires the OS specific headers.
GOOS=[insert OS] GOARCH=[insert arch] make version=v0.1.0 build-cli

# Debug mode
DNOTE_DEBUG=1 dnote sync