History

Jeremy Wharton c27da95742 Update index.html to be consistent with deployed code (#4140 ) This change is part of an ongoing effort to remove code from our branding repository. Co-authored-by: Stefan Benten <mail@stefan-benten.de>		2021-06-10 09:28:57 -05:00
..
scripts	web/satellite: add script to compile and compress wasm module	2021-04-30 15:48:56 +00:00
src	web/satellite: Update login area to use latest production code	2021-06-03 16:59:31 -04:00
static	web/satellite: replace initial cloud loader with a new one	2021-06-02 09:03:08 +00:00
tests/unit	web/satellite: replace initial cloud loader with a new one	2021-06-02 09:03:08 +00:00
.env	satellite: added ability to inject stripe public key post build (#3560 )	2019-11-18 13:38:43 +02:00
.gitignore	web/satellite: regular header reworked	2021-04-27 16:40:48 +00:00
babel.config.js	CSP implementation for satellite console (#2644 )	2019-07-30 13:13:24 +03: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	Update index.html to be consistent with deployed code (#4140 )	2021-06-10 09:28:57 -05:00
jestSetup.ts	updates copyright 2018 to 2019 (#1133 )	2019-01-24 15:15:10 -05:00
package-lock.json	satellite/analytics: Add analytics for "link shared" in objects view (#4130 )	2021-06-01 14:44:37 -07:00
package.json	web/satellite: bump object browser version	2021-05-19 16:01:15 +00:00
README.md	Merge 'master' branch	2020-11-10 11:58:59 +00:00
tsconfig.json	web/satellite: Remove client-side Segment analytics	2021-04-08 17:36:06 +00:00
tslint.json	web/satellite: vue-svg-loader implemented (#3307 )	2019-10-23 15:26:39 +03:00
vue.config.js	web/: ignore node_modules while linting css	2021-06-03 16:18:16 +03: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.
resetPassword folder: contains page template for password reset and success page that appears after.

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.