sunbird-va-ui-service

NCF Saarathi is an AI assitant service which assists about National Education Policy 2020 and National Curriculum Framework(Foundational Stage and School Education)

This project was generated with Angular CLI version 13.3.0.

Table of Contents

• Quick Start
• Installation
• Basic usage
• What's included
• Copyright and License
• [Development Server] (#development-server)

Quick Start

Prerequisites

Before you begin, make sure your development environment includes Node.js® and an npm package manager.

Node.js

Angular 13 requires Node.js version ^16.10.

• To check your version, run node -v in a terminal/console window.
• To get Node.js, go to nodejs.org.

Angular CLI

Install the Angular CLI globally using a terminal/console window.

npm install -g @angular/cli

Installation

$ npm install

Basic usage

# dev server with hot reload at http://localhost:4200
$ npm start

Navigate to http://localhost:4200. The app will automatically reload if you change any of the source files.

Build

Run build to build the project. The build artifacts will be stored in the dist/ directory.

# build for production with minification
$ npm run build

What's included

Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this:

Code Structure
├── src/                         # project root
│   ├── app/                     # main app directory
|   │   ├── containers/          # layout containers
|   |   │   └── default-layout/  # layout containers
|   |   |       └── _nav.js      # sidebar navigation config
|   │   ├── icons/               # icons set for the app
|   │   └── views/               # application views
│   ├── assets/                  # images, icons, etc.
│   ├── components/              # components for demo only
│   ├── scss/                    # scss styles
│   └── index.html               # html template
│
├── angular.json
├── README.md
└── package.json

Development server

Run Keycloak

Run Keycloak locally using docker image docker run -d -p 8080:8080 -e KEYCLOAK_USER=admin -e KEYCLOAK_PASSWORD=admin quay.io/keycloak/keycloak:17.0.1-legacy

Run UI

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

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.

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.