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
- This project depends on npm (NodeJS) to setup its dependencies. Please make sure you have npm installed. The Node.js version used in CI is in
.nvmrc (with nvm: nvm use); CI uses the npm that comes with it.
git clone this repository to get all the code with its configuration and requirements.npm install the dependencies (external libraries and packages)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.
Module-level documentation
Core modules have technical README.md files in their directories
for developers and agents to avoid expensive code exploration.
These provide architecture overviews, file organization, key concepts, and patterns specific to that module.
For example:
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.
This is the beginning of the README. Read the rest at the original. Read the full README ↗
