ndb-core

Aam Digital

Enabling social organizations digitally to transform lives.

Aam Digital is an easy-to-use case management software for the social sector that improves the effectiveness and transparency of work with beneficiaries in the field.

For more information about the software and an open demo system visit www.aam-digital.com.

For more information about the code including guides see the separate Developer Documentation

---

Installation, Use & Deployment

You can directly run the system using Docker. More information in our Aam-Digital/ndb-setup repository. In that case you do not have to clone this repository and install all the dependencies as everything is packaged into the docker image already.

The Aam Digital platform can be customized for different use cases through a flexible configuration file. This doesn’t require changes to the generic platform code base in this repository:

The overall architecture and tech stack including backend services looks like this:

Development

Setup

1. This project depends on npm (NodeJS) to setup its dependencies. Please make sure you have npm installed.
2. git clone this repository to get all the code with its configuration and requirements.
3. npm install the dependencies (external libraries and packages)
4. npm run start to run your local dev server and get started.

By default, the app is started with a “mock” session, generating demo data into an in-memory database. You can change this mode by editing the environment.ts (or create a file assets/config.json to overwrite settings; that file is on the .gitignore list).

If you need to develop in an advanced environment including local backend services, please refer to the instructions at Aam-Digital/aam-services/docs/developer.

Documentation

Our detailed Developer Documentation provides tutorials, guides, concepts and an API reference.

Translations (internationalization; i18n)

Aam Digital is available in multiple languages. We translate the terms using POEditor: Join the translation team

To commit latest translations to the codebase, trigger the manual GitHub Action in the repository.

Code Style

We use prettier to enforce a consistent formatting of code to make the project easier to read. The project is set up with a git pre-commit hook to automatically format your commits according to these rules.

Using Angular CLI

This project is built upon Angular. If you are unfamiliar with the framework and Angular CLI go check out the Angular CLI README or use ng help.

Design & UX

We have a Design System built in Figma with various building blocks for quick mockups:

Figma: Aam Digital - Design System

Build a docker image locally

Deployment on a server can be done through a docker image, our ndb-setup project provides tools and a starting point to run the system using docker. For more information about Docker, please refer to their official documentation.

To learn more about the build process, see /build.

---

AI-Assisted Development

This project supports AI-assisted development through GitHub Copilot, Claude Code, and CodeRabbit.

Tool	Usage
GitHub Copilot (VS Code)	Code generation, chat, agent mode — reads AGENTS.md. Use Plan mode for architecture planning before implementation.
Claude Code (CLI)	Interactive coding assistant — reads CLAUDE.md → AGENTS.md
CodeRabbit (GitHub)	Automated PR reviews — configured via .coderabbit.yaml. Add the label “Ready for Review” to trigger a review (works in draft mode too; removing the label stops further auto-reviews).

Agents

Custom agents are defined in .claude/agents/ and can be invoked from Copilot chat or Claude Code:

Agent	Purpose	Recommended Tool
business-analyst	Refine requirements into structured, testable docs	Copilot chat or Claude Code
troubleshooter	Debug issues using Sentry, devtools, and stack traces	Copilot/Claude Code with Sentry MCP
implementation-planner	Design technical approach and architecture	Copilot Plan mode or Claude Code
implementation-executor	Full implementation workflow with tests	Copilot agent mode or Claude Code
refactorer	Code analysis and refactoring suggestions	CodeRabbit (automatic) + manual prompt
e2e-test-writer	Generate Playwright e2e tests	Copilot agent mode or Claude Code

MCP Servers

MCP servers are configured in .vscode/mcp.json:

• angular-cli — Angular CLI operations, schematics, component generation
• chrome-devtools — Runtime debugging, DOM inspection, console access
• sentry — Production error data, issue investigation (requires SENTRY_AUTH_TOKEN env var)
• github — Issues, PRs, diffs, repository context (requires GITHUB_PERSONAL_ACCESS_TOKEN env var)

Tips for Effective Prompting

• Be specific about the entity/component you’re working with
• Reference existing patterns and similar implementations
• Let agents read relevant files first before making changes
• Use the agent files as starting points for common workflows

---

Contribute

Our project is completely run by volunteers. Contributions welcome!

We are trying hard to make it easy for you to join in. As a starting point, please refer to our CONTRIBUTING page.