Skip to content

Aam-Digital/ndb-core

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

90d8417 · Sep 22, 2022
Jul 5, 2022
Aug 23, 2022
Aug 15, 2022
Sep 21, 2022
Jul 5, 2022
Sep 22, 2022
Mar 9, 2021
May 29, 2018
Jan 11, 2021
May 19, 2017
Jul 5, 2022
Jul 5, 2022
May 19, 2020
Jul 23, 2021
Aug 15, 2020
Jul 5, 2017
Jul 28, 2022
Jul 19, 2022
Jul 5, 2022
Jul 5, 2022
Aug 12, 2022
Sep 22, 2022
Sep 22, 2022
Jul 28, 2022
Sep 1, 2022
Sep 22, 2022

Repository files navigation

Release Version Build Status Code Climate Test Coverage E2E Tests Guides Doc CoverageDocs Known Vulnerabilities

Aam Digital

Empowering social workers with simple to use software.

For more information about the software and a free 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.

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. create a config file assets/config.json by copying the default config assets/config.default.json that is part of the repository.
  5. npm run start to run your local dev server and get started.

Documentation

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

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 use ng help. The following sections give you a brief overview.

Development server

Run npm run start for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Code scaffolding (Generate new modules and components)

You can use Angular CLI to add new code to the project. Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|module.

Build

Run ng build -prod to build the project. The build artifacts will be stored in the dist/ directory. Use the -prod flag for a production build.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run npm run e2e to execute the end-to-end tests via Cypress in the terminal.

Run npm run e2e-open to execute the end-to-end tests via Cypress own User Interface.

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.


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.