storj/satellite/admin/ui
Mya cf462fcf92 satellite/admin: update geofence endpoints to follow response conventions
Change-Id: Ieff91c16f91f9720e9c3d8ead0e13c47651d23f5
2022-01-13 12:33:10 -06:00
..
assets satellite/admin/ui: Migrate to SvelteKit 2021-12-17 10:27:13 +00:00
src satellite/admin: update geofence endpoints to follow response conventions 2022-01-13 12:33:10 -06:00
static satellite/admin/ui: Migrate to SvelteKit 2021-12-17 10:27:13 +00:00
.eslintrc.cjs satellite/admin/ui: Migrate to SvelteKit 2021-12-17 10:27:13 +00:00
.gitignore satellite/admin/ui: Migrate to SvelteKit 2021-12-17 10:27:13 +00:00
.prettierrc satellite/admin/ui: Migrate to SvelteKit 2021-12-17 10:27:13 +00:00
package-lock.json satellite/admin/ui: Migrate to SvelteKit 2021-12-17 10:27:13 +00:00
package.json satellite/admin/ui: Migrate to SvelteKit 2021-12-17 10:27:13 +00:00
README.md satellite/admin/ui: Migrate to SvelteKit 2021-12-17 10:27:13 +00:00
svelte.config.js satellite/admin/ui: Migrate to SvelteKit 2021-12-17 10:27:13 +00:00
tsconfig.json satellite/admin/ui: Migrate to SvelteKit 2021-12-17 10:27:13 +00:00

Admin UI

Implementation details

This is a project based on the Sveltekit.

The project is set up with Typescript.

The Web App is currently straightforward as we specified that v1 would be.

The v1 is just a simple web page that exposes the Admin API through some forms and allow to a call the API without needing to use some HTTP REST clients (e.g. Postman, cURL, etc.). It doesn't offer any user authentication; the user has to know the API authorization token for using it.

The UI has a set of Svelte components that collaborate together to render an HTML form with input elements from the Admin API client. The Svelte components expect some values of a certain Typescript interfaces, types, and classes, for being able to dynamically render the HTML form and elements.

Each source has a brief doc comment about its functionality.

Development

Install the dependencies...

npm install

...then run the development server with autoreload on changes

npm run dev

Navigate to localhost:3000. You should see your app running.

Building for production mode

To create an optimized version of the app:

npm run build