Here are the steps to set up the frontend for the Sunbird RC Admin Portal:
-
Clone the Repository: Clone the repository to your local machine using Git by running the following command in your terminal:
git clone https://github.com/Sunbird-RC/Admin-Portal
-
Navigate to the Root Folder: Change your working directory to the root folder of the cloned repository:
cd Admin-Portal
-
Install Dependencies: Install the required project dependencies using either Yarn or npm. You can choose either of the following commands:
Using Yarn:
yarn
Using npm:
npm install
This command will download and install all the necessary dependencies specified in the project's
package.json
file. -
Configure Application Settings: Inside the
admin-portal/src/assets/config
directory, you will find aconfig.json
file. Open this file and update it with the configuration settings specific to your environment. This typically includes settings like the Keycloak configuration, base URLs, and any other environment-specific values.Example
config.json
file:{ "appType": "issuer", "keycloak": { "url": "https://domain/auth", "realm": "sunbird-rc", "clientId": "registry-frontend" }, "baseUrl": "http://localhost:4200/registry/api/v1", "domainName": "https://domain", "footerText": "Issuance Portal", }
Ensure that you replace
"your-realm-name"
,"your-keycloak-url"
,"your-client-id"
,"your-api-base-url"
, and any other relevant values with your actual configuration. -
Run the Application: After configuring the
config.json
file, you can start the application using Angular's development server. Run the following command:ng serve
This command will compile and build the application and start a development server. You should see output indicating that the server is running.
-
Access the Application: Once the development server is running, you can access the Sunbird RC Admin Portal in your web browser by navigating to:
http://localhost:4200/