Skip to content

GuardianLabs/polygon-dash

Repository files navigation

Polygon Dash

Polygon Dash contain two projects in a one repo:

  • Python backend app
  • Vue dashboard frontend

Polygon Dashboard

Usage

Polydash uses Poetry dependency manager.

  1. Install Poetry
    curl -sSL https://install.python-poetry.org | python3 -
  2. Install dependencies
    poetry install
  3. Enter Poetry-managed Python environment
    poetry shell
  4. The shell should change to something like (polydash-py3.10) ~/.../backend. Now run Polydash as Python module
    python -m polydash

Frontend

Run script to deploy:

```
 ./deploy_frontend.sh
```

Installing Node.js using NVM

Ubuntu or MacOS:

  1. Install NVM (Node Version Manager):

    curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash

    For MacOS run

    source .zshrc
  2. Install the latest LTS version of Node.js using NVM:

    nvm install --lts
  3. After running the above command, you can confirm your installation by checking the version of node:

    node -v

Project Setup

npm install

Compile and Hot-Reload for Development

npm run dev

Compile and Minify for Production

npm run build

Lint with ESLint

npm run lint

Run app in a docker

Run up and rebuild backed

docker compose up --build