Skip to content

Latest commit

 

History

History
108 lines (69 loc) · 3.99 KB

README.md

File metadata and controls

108 lines (69 loc) · 3.99 KB

Sample Application With Angular Router using Asgardeo Auth Angular SDK

This sample application is developed to demonstrate the usage of Asgardeo Auth Angular SDK with Angular Router.

This project was generated with Angular CLI version 10.2.0.

Table of Contents

Getting Started

Register an Application

Follow the instructions in the Try Out the Sample Apps section to register an application.

Make sure to add https://localhost:3000 and https://localhost:3000/signin/redirect as a Redirect URLs.

Add https://localhost:3000 under allowed origins.

Download the Sample

Download the sample from here and extract the zip file.

Configure the Sample

Update configuration file src/config.json with your registered app details.

Note: You will only have to paste in the client ID generated for the application you registered.

Read more about the SDK configurations here.

{
    "clientID": "<ADD_CLIENT_ID_HERE>",
    "baseUrl": "https://api.asgardeo.io",
    "signInRedirectURL": "https://localhost:3000/signin/redirect",
    "signOutRedirectURL": "https://localhost:3000"
}

Run the Application

npm install && npm start

The app should open at https://localhost:3000

Available Scripts

Install Angular CLI globally to use default angular scripts.

npm install -g @angular/cli

Development server

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

Change the Application's Development Server Port

By default, the development server runs on port 3000. Incase if you wish to change this to something else, follow the steps below.

  1. Update the PORT in .env file in the app root.
  2. Update the signInRedirectURL & signOutRedirectURL in src/config.json
  3. Go to the Asgardeo Console and navigate to the protocol tab of your application:
    • Update the Authorized Redirect URL.
    • Update the Allowed Origins.

Build

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

Lint

Run ng lint to lint the project. This app will use Angular EsLint for this purpose.

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.

Contribute

Please read Contributing to the Code Base for details on our code of conduct, and the process for submitting pull requests to us.

Reporting Issues

We encourage you to report issues, improvements, and feature requests creating Github Issues.

Important: And please be advised that security issues must be reported to security@wso2com, not as GitHub issues, in order to reach the proper audience. We strongly advise following the WSO2 Security Vulnerability Reporting Guidelines when reporting the security issues.

License

This project is licensed under the Apache License 2.0. See the LICENSE file for details.