# NgxDhis2ShellBoilerplate
This project was generated with Angular CLI version 17.0.0-rc.3.
# NG DHIS2 boilerplate
Boilerplate codes to fast track developing DHIS2 applications based on Angular framework
## Prerequisites
1. NodeJs (16 or higher)
2. git, can be installed by running `apt install git`
## Setup
Clone repository
```bash
git clone
github.com
```
Navigate to application root folder
```bash
cd
```
Install all required dependencies for the app
```bash
npm install --legacy-peer-deps
```
**NOTE**: Since you are using this boilerplate to start your new app, it is recommended that you find and replace every occurance of `facility-search` with the name of your intended app. Also provide better description of your app in `manifest.webapp`
## Development server
To start development server
```bash
npm start
```
Navigate to
localhost.
This command will require proxy-config.json file available in the root of your source code, usually this file has this format
```json
{
"/api": {
"target": "
play.dhis2.org",
"secure": "false",
"auth": "admin:district",
"changeOrigin": "true"
},
"/dhis-web-commons": {
"target": "
play.dhis2.org",
"secure": "false",
"auth": "admin:district",
"changeOrigin": "true"
},
"/icons": {
"target": "
play.dhis2.org",
"secure": "false",
"auth": "admin:district",
"changeOrigin": "true"
}
}
```
We have provided `proxy-config.example.json` file as an example, make a copy and rename to `proxy-config.json`
## Build
To build the project run
```bash
npm run build
```
The build artifacts will be stored in the `dist/`, this will include a zip file ready for deploying to any DHIS2 instance..
## Further help
To get more help on the Angular CLI use `ng help` or go check out the Angular CLI Overview and Command Reference page.