https://github.com/sanogotech/asgardeo-react-app
asgardeo-react-app WS20 Identity Server
https://github.com/sanogotech/asgardeo-react-app
Last synced: 2 months ago
JSON representation
asgardeo-react-app WS20 Identity Server
- Host: GitHub
- URL: https://github.com/sanogotech/asgardeo-react-app
- Owner: sanogotech
- License: apache-2.0
- Created: 2024-12-04T12:55:13.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-12-04T13:17:57.000Z (6 months ago)
- Last Synced: 2025-02-09T00:16:38.747Z (4 months ago)
- Language: TypeScript
- Size: 1.54 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Asgardeo Auth React SDK Usage Example (Single Page Application)
This sample is developed to demonstrate the basic usage of the Asgardeo Auth React SDK.
## Getting Started
### Prerequisites
- `Node.js` (version 10 or above).
### Register an Application
Follow the instructions in the [Try Out the Sample Apps](../../SAMPLE_APPS.md#try-out-the-sample-apps) section to register an application.
Make sure to add `https://localhost:3000` as a Redirect URL and also add it under allowed origins.
### Download the Sample
Download the sample from [here](https://github.com/asgardeo/asgardeo-auth-react-sdk/releases/latest/download/asgardeo-react-app.zip) 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](../../README.md#authprovider).
```json
{
"clientID": "",
"baseUrl": "https://api.asgardeo.io/t/",
"signInRedirectURL": "https://localhost:3000",
"signOutRedirectURL": "https://localhost:3000",
"scope": ["profile"]
}
```
**Full config dev WSO2 Identity Server:**
```json
{
"clientID": "",
"baseUrl": "https://localhost:9443",
"signInRedirectURL": "https://localhost:3000",
"signOutRedirectURL": "https://localhost:3000",
"scope": ["profile"]
}
```
### Run the Application
```bash
npm install && npm start
```
The app should open at [`https://localhost:3000`](https://localhost:3000)
### 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](.env) file in the app root.
2. Update the `signInRedirectURL` & `signOutRedirectURL` in [src/config.json](./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.
## Contribute
Please read [Contributing to the Code Base](http://wso2.github.io/) 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](https://github.com/asgardeo/asgardeo-auth-react-sdk/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](../../LICENSE) file for details.