diff --git a/README.md b/README.md index ef67aaa..7bdc2d0 100644 --- a/README.md +++ b/README.md @@ -37,9 +37,10 @@ - [About the project](#about-the-project) -- [Get started](#get-started) - - [Use a release](#use-a-release) - - [Building the application from source](#build-the-application-from-source) +- [Project Structure](#project-structure) + - [Sveltekit App](#sveltekit-app) + - [Sveltekit Build](#sveltekit-build) + - [Electron App](#electron-app) - [Contribute](#contribute) - [License](#license) - [Discuss](#discuss) @@ -60,12 +61,14 @@ This Electron IdentityNow starter is a template for a desktop application you ca ## Project Structure The current implementation of this app has three main folders: -- `Electron-App` - `Sveltekit-App` - `Sveltekit-Build` +- `Electron-App` The purpose of each of these folders is to hold a different portion of the total app, or rather different stages of the application. +

(back to top)

+ ### 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. @@ -73,16 +76,23 @@ The `Sveltekit-App` folder contains the main content of the application, this is 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](https://kit.svelte.dev). -If you use our base to build on top of, you will get a number of things implemented right out of the box: +If you use this starter 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 +- a Desktop build of your app +- TypeScript +- SvelteKit +- TailwindCSS + +

(back to top)

### 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` +

(back to top)

+ ### 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.