History

Vitalii Shpital 1d8342ab17 web/satellite: fixed access grant web worker caching issue Fixed caching issue by using regular Webassembly.instantiate instead of instantizteStreaming which fails to work in chrome sometimes. Now web worker instantiation is part of initial app loading process. This fixes go-rod test flakiness. Change-Id: I5300e70d4e0866f2321df86ce729f32b588bc5c4		2021-10-07 14:31:04 +00:00
..
scripts	web/satellite: add script to compile and compress wasm module	2021-04-30 15:48:56 +00:00
src	web/satellite: fixed access grant web worker caching issue	2021-10-07 14:31:04 +00:00
static	web/satellite: fixed access grant web worker caching issue	2021-10-07 14:31:04 +00:00
tests/unit	testsuite/ui/satellite: refactored go-rod tests selectors a little bit	2021-10-04 12:52:40 +00:00
.env	satellite: added ability to inject stripe public key post build (#3560 )	2019-11-18 13:38:43 +02:00
.eslintrc.js	web/: add custom linter for requiring @vue/component	2021-09-01 13:56:37 +00:00
.gitignore	web/satellite: regular header reworked	2021-04-27 16:40:48 +00:00
.stylelintignore	web/: add custom linter for requiring @vue/component	2021-09-01 13:56:37 +00:00
.stylelintrc.js	web/: add custom linter for requiring @vue/component	2021-09-01 13:56:37 +00:00
babel.config.js	web/satellite: switch to eslint, sass, bump deps	2021-08-03 15:56:33 +00:00
Dockerfile	build: update node to v14.15.3 (#4007 )	2020-12-20 17:20:19 +01:00
entrypoint	Adding dockerfile for running the web UI for Satellite (#1366 )	2019-02-28 13:18:53 -07:00
index.html	web/satellite, satellite/console: return old onboarding flow with feature flag	2021-09-21 11:37:30 +00:00
jestSetup.ts	web/satellite: don't ignore Vue errors and warnings	2021-09-29 16:26:54 +00:00
package-lock.json	web: move eslint-storj to separate repo	2021-10-05 12:08:44 +00:00
package.json	web: move eslint-storj to separate repo	2021-10-05 12:08:44 +00:00
README.md	web/satellite,satellite/console: Overhaul password reset	2021-08-12 17:40:53 +00:00
tsconfig.json	web/satellite: Remove client-side Segment analytics	2021-04-08 17:36:06 +00:00
vue.config.js	web/satellite: switch to eslint, sass, bump deps	2021-08-03 15:56:33 +00:00

README.md

storj-dev-panel

Project setup

npm install

Compiles and hot-reloads for development

npm run serve

Compiles and minifies for production

npm run build

Run your tests

npm run test

Lints and fixes files

npm run lint

Run your unit tests

npm run test:unit

Build docker container

From root of the repository, run:

make satellite-ui-image

Run docker container

docker run -p 8080:8080 storjlabs/satellite-ui:latest

1. Project structure:

src folder: contains main project components such as api, store, router, etc.
static folder: contains all project static resources such as images, fonts, pages.
tests folder: - contains project unit tests.
configuration files.

src

api folder: contains API for project modules such as auth, project, etc. We are using both GraphQL and HTTP implementations.
components folder: contains hierarchy of vue single file components sorted thematically.
router folder: contains project browser locations structure file.
store folder: contains global state management file broken into modules.
types folder: contains project classes and types.
utils folder: contains constants, plugins and utility files for formatting, validation, data transferring, etc.
views folder: same as components, but for root ones.
App.vue root project component.
main.ts Vue instance initialization file. Here filters and declarations are placed. Also plugins, store and router are connecting to Vue instance.

static

activation folder: contains page template that appears after account verification via email.
emails folder: contains all emails templates.
errors folder: contains 50x and 40x error pages templates.
fonts folder: contains Inter font sets in ttf format.
images folder: contains illustrations.
reports folder: contains usage report table template.

tests

unit folder: contains project unit tests.

Configuration files

.env: file for environment level variables.
.gitignore: folders, files and extensions which are ignored for git.
babel.config.js: babel configuration for javascript transcompilation.
index.html: DOM entry point.
jestSetup.ts: jest configuration for unit testing.
package.json: file holds various metadata relevant to the project such as version, dependencies, scripts and configurations.
tsconfig.json: holds TypeScript configurations.
tslint.json: holds TypeScript linter configurations.
vue.config.js: holds Vue configurations.