web-mev documentation

WebMEV

General information

The front end Angular 9 application for the MEV web application.

Compodoc documentation: click here

Respository: https://github.com/web-mev/mev-frontend

Sentry error tracking and monitoring: http://35.199.2.238:9000/organizations/sentry/issues/

The application is based on a Angular Material Starter project: https://github.com/tomastrajan/angular-ngrx-material-starter

Installation

Install the dependencies:


npm install
  • Run the local development server:

ng serve

(you can access the app at http://localhost:4200)

or


ng serve --port 8080 --host mydomain.com

(for development purposes we need a proper host pointing to localhost, because Google’s OAuth requires redirect URLs that can’t be localhost. So you can add an entry in the hosts file of your machine to associate mydomain.com to 127.0.0.1. The app will be run at http://mydomain.com:8080)

  • Generate project documentation:

npm run generate-docs

Settings

  • File app.component.ts Use the following properties to update the application settings: -- logo: to update the application logo image -- languages: to set the list of available languages -- sessionTimeout: to set user idle / session timeout -- navigation: to set top navigation bar

  • File themes/default-theme.scss Here you can change the color theme, specifying primary, accent and warning colors that will be used on components

  • File sentry-error-handler.ts Use this file to set a configuration to handle error tracking

  • File jwtConfig.ts Use this file to update settings for JWT authentication: whiteListedDomains(domains that are allowed to receive the JWT) and blackListedRoutes(routes that are not allowed to receive the JWT token)

Modules and components info

The structure of the application includes a few main modules:

  1. File Manager Module Includes components for uploading and managing user files. Users can upload files from local computer, Dropbox, rename files, edit file types, delete files. To add: download files to local computer, download to Dropbox
  2. Workspace Manager Module Contains the WorkspaceList component for managing user's workspace and a set of modal dialogs to add/edit/delete a workspace
  3. Workspace Details Module It is used to display the content of a workspace. It contains the WorkspaceDetails component which is used to display list of files (resources) included in the selected workspace. Also contains components for managing workspace metadata (user's custom observation and feature sets saved in the local storage) and modal dialogs for create/edit/delete actions.
  4. Analysis Module It contains components used on the Analysis Flow, Tools, Analyses Result.
  5. D3 Module It contains components (D3-charts and tables) used for different types of analyses (HCL, PCA, DESeq2, etc)
  6. Shared Module Contains commonly used directives, pipes, validators, help functions, shared components

Features and bugs

https://docs.google.com/spreadsheets/d/1hyKzuzDYb5nYS1AKZByssyCLNSQS-FxEqEdQ82IakQ8/edit#gid=0

result-matching ""

    No results matching ""