Skip to content

Latest commit

 

History

History
88 lines (63 loc) · 3.32 KB

README.md

File metadata and controls

88 lines (63 loc) · 3.32 KB
Raw

Asgardeo Vite React Template

This template enables you to create a Vite React application integrated with Asgardeo authentication, built for modern web development. It leverages tmplr to streamline project initialization, offering a customizable and scalable setup.

Table of Contents

Features

  • Vite: Super-fast build tool for modern web development.
  • React: A popular JavaScript library for building user interfaces.
  • Asgardeo: Managed Identity as a Service (IDaaS) for secure user authentication.
  • tmplr: Template management to easily bootstrap and configure your project.

Prerequisites

Before you begin, make sure you have the following installed on your machine:

  • Node.js (v14 or later)
  • npm or yarn
  • An Asgardeo Account to configure OAuth2 authentication.

Getting Started

1. Configure Asgardeo Application

  • Log in to your Asgardeo Console.

  • On the Asgardeo Console, go to Applications.

  • Click New Application and select Single-Page Application.

  • Enter the following details when creating the application:

    Field Name Description
    Name Give a unique name to identify your application.
    Authorized redirect URLs The URL to which the user is redirected after a successful login. Use the following URL for this app: http://localhost:5173

  • Click Register to complete the registration.

  • Go to the Protocol tab and take note of the Client ID. You will need it to configure the application later.

Folder Structure

asgardeo-vite-react-template/
├── template/
│   ├── assets/             # Static assets (images, styles)
│   ├── components/         # Reusable React components
│   ├── pages/              # Page-level components
│   ├── App.jsx             # Main App component
│   └── main.jsx            # Entry point for Vite and React
|   ├── vite.config.js      # Vite configuration file
|   └── package.json        # Project dependencies and scripts
├── public/                 # Static files served by Vite
├── .tmplr.yaml/            # tmplr recipe file

Running the Recipe

  1. To create a new Vite React application using Asgardeo Vite React Template run the following command.
npx tmplr --dir my-vite-react-app asgardeo/asgardeo-vite-react-template

  1. Input the necessary details when you are prompted in the CLI.

  2. Install the dependencies by running the following command from the root directory.

cd my-vite-react-app 
npm install
  1. To start the application run the following command.
npm run dev

License

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