Skip to content

genesis-community/genesis-ui

Repository files navigation

This is Genesis UI

  • Frontend Design Prototype is in Figma and mind chart in Lucidchart
  • Frontend will be using HTML CSS/SCSS and React
  • Backend will be implement using Golang with Gin Gonic web framework.
  • Login Sequence Flow Chart here

Phases for The Genesis UI

Phase 1: Informational Interface.

See below for Make Commands The informational Interface will contains three web pages:

  • A login page for developers to login using their S&W credentials.
  • A home page for showing most recent viewed deployment details, a sandwich menu for accessing account information, and a navigation bar for accessing list of deployments with filter categories such as the region(US East / US West) or deployment type(Lab / Products / Others). The home page also contains a youtube tutorial explaining the UI and helping new users to get familiar with GENESIS UI.
  • A Deployment page for hosting all information (company, region, infrastructure and etc) of the selected deployment for detailed information.

Current focus:

  • Improving prototype based on deployment filters and specifications.
  • Getting familiar with Golang and Gin Gonic for backend.
  • Enhancing React Prototype for the login page implementation and functionality.

Phase 2: Compare Deployment.


Phase 3: Functional Interface.


Phase 4: Health Monitoring.

---'

steps to build and run the genesis-ui

1.Create a .env file in the genesis-ui folder 2.And set the values for the below envirnoment variable in .env file

    VAULT_TOKEN=
    VAULT_DATA_PREFIX=secret
    VAULT_LIST_PREFIX=secret
    VAULT_ADDR=https://vault.lab.starkandwayne.com
    VAULT_SKIP_VERIFY=true
For the VAULT_TOKEN get the token value by doing `cat .svtoken` in you home directory

3.Then create a symbolic link for the .env file to backend/.env and cron/.env file ln -s $PWD/.env backend/.env and ln -s $PWD/.env cron/.env

4.Then do make all

Make Commands

  • make all - Run docker build to create genesis-ui image from DockerFile and docker run to create a genesis-ui container based on genesis-ui image to hosting Genesis UI.
  • make stop - Stop genesis-ui container from running and then remove container and image.
  • make build - Build the genesis-ui image from DockerFile.
  • make start - Starts a genesis-ui container.
  • make logs - View Gin Gonic logs.
  • make logs-tail - View Gin Gonic logs in detail.