![Issues][issues-shield]
![Contributor Shield][contributor-shield]
[issues-shield]:https://img.shields.io/github/issues/sailpoint-oss/electron-identitynow-starter?label=Issues
[contributor-shield]:https://img.shields.io/github/contributors/sailpoint-oss/electron-identitynow-starter?label=Contributors
[product-screenshot]: ./assets/images/electron-identitynow-starter-output.png
- [About the project](#about-the-project)
- [SvelteKit](#sveltekit)
- [Electron](#electron)
- [Using the starter](#using-the-starter)
- [Installing Dependencies](#installing-dependencies)
- [Local Development](#local-development)
- [Build the application from source](#build-the-application-from-source)
- [Contribute](#contribute)
- [License](#license)
- [Discuss](#discuss)
## About the project
The UI Development Kit is a template for building desktop applications integrating with Identity Security Cloud.
(back to top)
### SvelteKit
SvelteKit is a framework that allows easy application development, utilizing both front-end and back-end components, as well as modern security standards. When you're ready to build the UI development kit, it allows you to compile your code into numerous different deployment methods by using different adapters (static html, node server, edge, or lambda functions).
[SvelteKit can be explored more here](https://kit.svelte.dev).
If you use this starter to build on top of an existing project, you will get several things implemented right out of the box:
- OAuth Flow
- SailPoint SDK
- Desktop build of your application
- TypeScript
- SvelteKit
- TailwindCSS
(back to top)
### Electron
`Electron` is a framework that allows you to build cross-platform desktop applications, using web technologies. It combines the Chromium rendering engine and the Node.js runtime to allow you to build applications that can run on Windows, Mac, and Linux.
In the projects `src` folder, there are two additional folders: `main` and `preload`. These folders contain the code relevant to the electron portion of the application. The electron portion of the application is where you determine the window theme, size, shape, and behavior as well as the startup logic for the application.
(back to top)
## Use the starter
To use this starter application, you must install NPM. You can find instructions about how to install NPM [here](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
Once you have NPM installed, you can clone this repository and run the following commands, depending on your package manager of choice.
### Install dependencies
To install the dependencies, run `install` using your package manager of choice:
```bash
# NPM
npm install
```
```bash
# Yarn
yarn install
```
```bash
# PNPM
pnpm install
```
(back to top)
### Local Development
To start the application in development mode, first [install dependencies](#installing-dependencies). Then run the `dev` script using your package manager of choice:
```bash
# NPM
npm run dev
```
```bash
# Yarn
yarn dev
```
```bash
# PNPM
pnpm dev
```
(back to top)
### Build the application from source
To build the application from source, first [install dependencies](#installing-dependencies). Then run the `build` script matching your OS platform, using your package manager of choice:
| Command | Description | OS |
| --- | --- | --- |
| `build:win` | Builds the application for Windows. | Windows |
| `build:mac` | Builds the application for MacOS. | MacOS |
| `build:linux` | Builds the application for Linux. | Linux |
```bash
# NPM
npm run build:win
```
```bash
# Yarn
yarn build:mac
```
```bash
# PNPM
pnpm build:linux
```
(back to top)
## 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](https://developer.sailpoint.com/discuss/tag/electron-identitynow-starter) to discuss this tool with other users!
(back to top)
