ui-development-kit/README.md

IdentityNow Admin Console - README

A desktop application to administer and troubleshoot IdentityNow
Report Bug · Request Feature

• About the project
• Get started
  • Use a release
  • Building the application from source
• Contribute
• License
• Discuss

About the project

This Electron IdentityNow starter is a template for a desktop application you can use build out GUI applications that integrate with IdentityNow.

(back to top)

Project Structure

The current implementation of this app has three main folders:

• Electron-App
• Sveltekit-App
• Sveltekit-Build

The purpose of each of these folders is to hold a different portion of the total app, or rather different stages of the application.

Sveltekit-App

The Sveltekit-App folder contains the main content of the application, this is where you will likely be doing 90% of your development.

SvelteKit is a framework that allows easy development of applications utilizing both frontend and backend components and modern security standards, and when you are ready to build it allows you to compile your code into numerous different deployment methods using different adapters (static html, node server, edge or lambda functions).
SvelteKit can be explored more here.

If you use our base to build on top of, you will get a number of things implemented right out of the box:

• an OAuth Flow
• the SailPoint SDK
• an Electron Desktop application version of your application

Sveltekit-Build

When you are ready to build your application, running the build command in the Sveltekit-App folder, will build the application using the node adapter for SvelteKit, and the build will be placed in the folder Sveltekit-Build/src

Electron-App

The Electron-App folder contains the code relevant to the electron portion of the application, this is where you determine the window theme, size, shape, and behavior as well as the startup logic for the application.

Currently when running the electron application, the handler that is generated from the sveltekit build is imported and passed to an express server that runs the application, an electron window is then opened pointing at that local express server, so once the app is running you can even open the app directly in a web browser if you prefer.

(back to top)

Build the application from source

Prerequisites:

• To build the application from source you will need NPM installed. You can find instructions on how to install NPM here.

Once you have NPM installed, you can clone this repository and run the following commands in the specified order and folders:

Go to the folder: ./Sveltekit-App First, run this command:

npm install

Then run this command:

npm run build

Next, go to the folder: ./Electron-App First, run this command:

npm install

Then, run this command:

npm run build

As long as there are no errors during the build process, the built application binaries will then be located in the ./Electron-App/out folder.

Contribute

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion to improve this project, please fork the repo and create a pull request. You can also make a suggestion by opening an issue with the tag enhancement. Don't forget to give the project a star! Thanks again!

Follow these steps to make contributions:

1. Fork the project.
2. Create your feature branch: git checkout -b feature/AmazingFeature
3. Commit your changes: git commit -m 'Add some AmazingFeature'
4. Push to the branch: git push origin feature/AmazingFeature
5. Open a pull request.

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Discuss

You can go to the SailPoint Developer Community Forum to discuss this tool with other users!

(back to top)