storj/web/satellite
VitaliiShpital 4544f2dffb web/satellite: navigation side bar reworked
Change-Id: I9be2d23a7a4af219d0b8888b7296fa7b0e57fc5a
2020-05-18 11:04:45 +00:00
..
src web/satellite: navigation side bar reworked 2020-05-18 11:04:45 +00:00
static web/satellite: navigation side bar reworked 2020-05-18 11:04:45 +00:00
tests/unit web/satellite: navigation side bar reworked 2020-05-18 11:04:45 +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: downgrade typescript and pin stuff (#2918) 2019-08-29 17:27:48 -06:00
babel.config.js CSP implementation for satellite console (#2644) 2019-07-30 13:13:24 +03:00
Dockerfile Adding dockerfile for running the web UI for Satellite (#1366) 2019-02-28 13:18:53 -07:00
entrypoint Adding dockerfile for running the web UI for Satellite (#1366) 2019-02-28 13:18:53 -07:00
index.html web/satellite: redirect to verification page on sign up if inside iframe 2020-04-16 13:35:49 +00:00
jestSetup.ts updates copyright 2018 to 2019 (#1133) 2019-01-24 15:15:10 -05:00
package-lock.json satellite/console: handling graphql errors bug fix 2020-02-24 16:22:09 +00:00
package.json satellite/console: handling graphql errors bug fix 2020-02-24 16:22:09 +00:00
README.md web/satellite: readme structure section 2020-03-17 15:16:49 +00:00
tsconfig.json satellite/web: add segmentio plugin (#3405) 2019-11-27 11:57:59 -05:00
tslint.json web/satellite: vue-svg-loader implemented (#3307) 2019-10-23 15:26:39 +03:00
vue.config.js web/satellite: browser caching bug fixed 2020-03-23 14:41:20 +00:00

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 extentions 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.