Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
paritshivani authored Sep 6, 2024
1 parent d60983e commit d48b7da
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,28 @@
# nulp-elite-ui

Repository for NULP Webapp
## What is the NULP webapp?
The NULP portal is the webapp interface for the NULP learner application stack. It provides a web-app through which all functionality of NULP can be accessed along with few extra functionalities listed below.

## Getting started
To get started with the NULP portal, please try out our dev and demo site at:https://devnulp.niua.org/webapp/domainList (Please consider minor flows as this is devolopment instance)

### Local Installation
You can also install the Sunbird portal locally on your laptop, please follow following steps
1. Make fork and clone of this repo

2. Place this repo in Nulp portal repo at path "nulp-portal/src/app/".(Repo: https://github.com/NIUANULP/nulp-portal/tree/elite-deployment-test)

3. In Nulp portal path "nulp-portal/src/app" follow following steps:

-a. Use Node version : v16.19.0
-b. complete `yarn install`
-c. Run `node server.js`

5. Now in path "nulp-portal/src/app/nulp-elite-ui" follow following steps:

-a. Use Node version : v18.16.0
-b. complete `yarn install`
-c. Run `yarn build`

## Reporting Issues
We have an active [issue tracker](https://tracker.tekdi.net/projects/nulp-platform-enhancement-phase-2). Please report any issues.

0 comments on commit d48b7da

Please sign in to comment.