Serenity Notes

A powerful cross-platform productivity application that seamlessly integrates task management (ActionHub) and journaling for enhanced productivity and mindfulness.

Features

ActionHub: Comprehensive task management with projects, priorities, and due dates
Journal: Private, secure journaling with rich text editing and tagging
Analytics: Productivity insights and progress tracking
Cross-Platform: Desktop (Electron) and Mobile (React Native) applications
Self-Hosted: Full control over your data with PostgreSQL database
Dark/Light Themes: Customizable appearance with system preference detection
Offline-First: Works seamlessly without internet connection

Architecture

Serenity Notes uses a monorepo architecture with shared packages:

serenity/
├── packages/
│   ├── core/         # Business logic, Redux store, TypeScript types
│   ├── ui/           # Shared UI components with Tailwind CSS
│   └── database/     # PostgreSQL schema and query functions
├── apps/
│   ├── desktop/      # Electron application
│   └── mobile/       # React Native application (coming soon)
├── screenshots/      # UI mockups and designs
└── docs/            # Documentation

Technology Stack

Frontend: React 18, TypeScript, Tailwind CSS
State Management: Redux Toolkit with RTK Query
Desktop: Electron with security best practices
Mobile: React Native with NativeWind
Database: PostgreSQL with pg-promise
Build System: Turborepo, Vite, TypeScript
Styling: Tailwind CSS with custom design system

Prerequisites

Before running Serenity Notes locally, ensure you have:

Node.js 18.0 or higher
npm 9.0 or higher
PostgreSQL 14.0 or higher (for database functionality)
Git for version control

Quick Start

1. Clone and Install

# Clone the repository
git clone https://github.com/your-username/serenity-notes.git
cd serenity-notes

# Install dependencies for all packages
npm install

# Build shared packages
npm run build

2. Database Setup (Optional)

If you want full functionality with data persistence:

# Install PostgreSQL (macOS)
brew install postgresql
brew services start postgresql

# Create database
createdb serenity_notes

# Set up environment variables
cp .env.example .env
# Edit .env with your database credentials

Example .env file:

DATABASE_HOST=localhost
DATABASE_PORT=5432
DATABASE_NAME=serenity_notes
DATABASE_USER=your_username
DATABASE_PASSWORD=your_password
NODE_ENV=development

3. Development

# Start development servers for all apps
npm run dev

# Or start specific applications
npm run dev --filter=@serenity/desktop
npm run dev --filter=@serenity/mobile

The desktop app will be available at http://localhost:3000 in development mode.

4. Building for Production

# Build all packages
npm run build

# Build specific app
npm run build --filter=@serenity/desktop

Package Scripts

Root Level Commands

npm run dev          # Start all apps in development mode
npm run build        # Build all packages and apps
npm run lint         # Lint all packages
npm run test         # Run tests across all packages
npm run clean        # Clean all build artifacts
npm run format       # Format code with Prettier

Desktop App Commands

cd apps/desktop

npm run dev          # Start development with hot reload
npm run build        # Build renderer and main process
npm run electron     # Run built electron app
npm run start        # Build and run electron app
npm run dist         # Create distribution packages
npm run lint         # Lint desktop app code

Desktop App Distribution

Building Distributables

cd apps/desktop

# Install electron-builder if not already installed
npm install --save-dev electron-builder

# Add to package.json
npm pkg set build.appId="com.serenity.notes"
npm pkg set build.productName="Serenity Notes"
npm pkg set build.directories.output="dist"
npm pkg set build.files[0]="dist/**/*"
npm pkg set build.files[1]="node_modules/**/*"
npm pkg set build.files[2]="package.json"

# Build for current platform
npm run dist

# Build for specific platforms
npm run dist -- --mac
npm run dist -- --win
npm run dist -- --linux

Distribution Configuration

Add to apps/desktop/package.json:

{
  "build": {
    "appId": "com.serenity.notes",
    "productName": "Serenity Notes",
    "directories": {
      "output": "dist"
    },
    "files": [
      "dist/**/*",
      "node_modules/**/*",
      "package.json"
    ],
    "mac": {
      "category": "public.app-category.productivity",
      "icon": "assets/icon.icns",
      "target": [
        {
          "target": "dmg",
          "arch": ["x64", "arm64"]
        }
      ]
    },
    "win": {
      "icon": "assets/icon.ico",
      "target": [
        {
          "target": "nsis",
          "arch": ["x64"]
        }
      ]
    },
    "linux": {
      "icon": "assets/icon.png",
      "target": [
        {
          "target": "AppImage",
          "arch": ["x64"]
        },
        {
          "target": "deb",
          "arch": ["x64"]
        }
      ]
    }
  }
}

Creating App Icons

Create icons in the following sizes and formats:

apps/desktop/assets/
├── icon.icns     # macOS (512x512)
├── icon.ico      # Windows (256x256)
└── icon.png      # Linux (512x512)

Use tools like:

macOS: iconutil or online converters
Windows: GIMP, Paint.NET, or online converters
Linux: Any image editor that exports PNG

Auto-Updates (Optional)

For automatic updates, integrate with services like:

electron-updater with GitHub Releases
Hazel for simple update server
Nuts for advanced update management

Mobile App Setup

React Native Development

cd apps/mobile

# iOS setup (macOS only)
npx pod-install

# Start Metro bundler
npm start

# Run on iOS simulator
npm run ios

# Run on Android emulator
npm run android

Prerequisites for Mobile Development

iOS Development: Xcode 14+, iOS Simulator
Android Development: Android Studio, Android SDK, Android Emulator
React Native CLI: npm install -g @react-native-community/cli

Database Migration

To set up the database schema:

# Navigate to database package
cd packages/database

# Run migrations (when implemented)
npm run migrate

# Seed with sample data (when implemented)
npm run seed

Manual setup:

# Connect to PostgreSQL
psql serenity_notes

# Run the schema file
\i packages/database/src/schema/schema.sql

Development Guidelines

Code Style

TypeScript: Strict mode enabled, no any types
ESLint: Configured for React, TypeScript, and accessibility
Prettier: Consistent code formatting
Conventional Commits: Use conventional commit messages

Package Development

When developing shared packages:

# Watch for changes in core package
cd packages/core && npm run dev

# Watch for changes in UI package
cd packages/ui && npm run dev

Adding Dependencies

# Add to specific package
npm install <package> --workspace=@serenity/core

# Add to root (dev dependencies)
npm install <package> --save-dev

Testing

# Run all tests
npm run test

# Run tests for specific package
npm run test --filter=@serenity/core

# Run tests in watch mode
npm run test:watch

Troubleshooting

Common Issues

Build Failures

# Clean and rebuild
npm run clean
npm install
npm run build

Database Connection Issues
- Verify PostgreSQL is running: brew services list | grep postgresql
- Check connection string in .env
- Ensure database exists: psql -l

Electron Issues

# Rebuild native modules
cd apps/desktop
npm run electron-rebuild

TypeScript Errors

# Check TypeScript configuration
npx tsc --noEmit

Getting Help

Issues: Report bugs and feature requests on GitHub Issues
Discussions: Join community discussions on GitHub Discussions
Documentation: Check the /docs folder for detailed guides

Contributing

Fork the repository
Create a feature branch: git checkout -b feature/amazing-feature
Commit changes: git commit -m 'feat: add amazing feature'
Push to branch: git push origin feature/amazing-feature
Open a Pull Request

Development Workflow

# 1. Install dependencies
npm install

# 2. Start development
npm run dev

# 3. Make changes and test
npm run test
npm run lint

# 4. Build for production
npm run build

# 5. Create distribution (desktop)
cd apps/desktop && npm run dist

License

This project is licensed under the MIT License - see the LICENSE file for details.

Roadmap

Acknowledgments

Design inspiration from modern productivity tools
Icons by Lucide
UI components influenced by shadcn/ui

Built with ❤️ for productivity and mindfulness

Name		Name	Last commit message	Last commit date
Latest commit History 15 Commits
apps		apps
packages		packages
scripts		scripts
.env.example		.env.example
.eslintrc.js		.eslintrc.js
.gitignore		.gitignore
.prettierrc		.prettierrc
CLAUDE.md		CLAUDE.md
CONTRIBUTING.md		CONTRIBUTING.md
README.md		README.md
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json
turbo.json		turbo.json

digitaltracer/serenity

Folders and files

Latest commit

History

Repository files navigation

Serenity Notes

Features

Architecture

Technology Stack

Prerequisites

Quick Start

1. Clone and Install

2. Database Setup (Optional)

3. Development

4. Building for Production

Package Scripts

Root Level Commands

Desktop App Commands

Desktop App Distribution

Building Distributables

Distribution Configuration

Creating App Icons

Auto-Updates (Optional)

Mobile App Setup

React Native Development

Prerequisites for Mobile Development

Database Migration

Development Guidelines

Code Style

Package Development

Adding Dependencies

Testing

Troubleshooting

Common Issues

Getting Help

Contributing

Development Workflow

License

Roadmap

Acknowledgments

About

Resources

Contributing

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages