README.md

February 9, 2024 · View on GitHub

image

This sample app demonstrates how to integrate the Descope authentication service into an Angular application. This application includes a login screen using Descope Angular SDK, a user dashboard to display user information and a navigation bar that dynamically adjusts based on the user's authentication state.

Table of Contents 📝

  1. Features
  2. Installation
  3. Running the Application
  4. Issue Reporting

Features ✨

  • Descope Login: Users can login with their Descope credentials.
  • User Dashboard: After logging in, users are redirected to a dashboard which displays their information fetched using the Descope SDK.
  • Navbar: A navigation bar that includes a login/logout button, which adjusts its display based on whether a user is logged in or not.

Installation 💿

  1. Clone the repository:
git clone git@github.com:descope-sample-apps/angular-sample-app.git
  1. Install dependencies:
cd descope-angular-app
yarn install
  1. Setup environment variables:

  • Use the environment.ts.example file, located in /src/environments/environment.ts.example, and change the name to environment.ts.

  • Fill in the variable descopeProjectId with your Project ID from Project Settings in the Console.

export const environment = {
    production: false,
    descopeProjectId: "<Descope Project ID>",
};

Running the Application 🚀

To start the application, run:

yarn start

Navigate to http://localhost:4200/ in your browser.

Issue Reporting ⚠️

This project is a simple demonstration of integrating Descope into an Angular application. For any issues or suggestions, feel free to open an issue in the GitHub repository.

License 📜

This project is licensed under the MIT License - see the LICENSE file for details.