update README.md, add .env and update package.json

.gitignore

@@ -30,7 +30,7 @@ lerna-debug.log
 
 # Environment variables files
 .env
-!samples/asgardeo-react-app/.env
+!samples/asgardeo-vite-app/.env
 !samples/asgardeo-react-ts-app/.env
 .env.local
 .env.development.local

samples/asgardeo-react-app/README.md

@@ -47,7 +47,7 @@ The app should open at [`https://localhost:3000`](https://localhost:3000)
 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.
+1. Update the `PORT` in [.env](../asgardeo-vite-app/.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.

samples/asgardeo-vite-app/.env

@@ -0,0 +1,4 @@
+PORT=3000
+HOST="localhost"
+DISABLE_DEV_SERVER_HOST_CHECK=false
+HTTPS=true

samples/asgardeo-vite-app/README.md

@@ -1,8 +1,68 @@
-# React + Vite
+# Asgardeo Auth React SDK Usage Vite Example (Single Page Application)
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+This sample is developed to demonstrate the basic usage of the Asgardeo Auth React SDK.
 
-Currently, two official plugins are available:
+## Getting Started
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+### 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": "<ADD_CLIENT_ID_HERE>",
+    "baseUrl": "https://api.asgardeo.io/t/<org_name>",
+    "signInRedirectURL": "https://localhost:3000",
+    "signOutRedirectURL": "https://localhost:3000",
+    "scope": ["profile"]
+}
+```
+
+### Run the Application
+
+```bash
+npm install && npm run dev
+```
+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.

samples/asgardeo-vite-app/package.json

@@ -1,5 +1,31 @@
 {
   "name": "asgardeo-vite-app",
+  "description": "VIte based sample SPA to demonstrate Asgardeo / WSO2 Identity Server Auth React SDK usage",
+  "keywords": [
+    "Asgardeo",
+    "WSO2",
+    "WSO2 IS",
+    "WSO2 Identity Server",
+    "OIDC",
+    "SDK",
+    "React",
+    "Single Page Application",
+    "SPA",
+    "Sample",
+    "Javascript",
+    "Typescript",
+    "Authenticate"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/asgardeo/asgardeo-auth-react-sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/asgardeo/asgardeo-auth-react-sdk/issues"
+  },
+  "homepage": "https://github.com/asgardeo/asgardeo-auth-react-sdk#readme",
+  "author": "WSO2",
+  "license": "Apache-2.0",
   "private": true,
   "version": "0.0.0",
   "type": "module",