https://github.com/blinklabs-io/cloudstruct-vm-frontend
CloudStruct Frontend for VM
https://github.com/blinklabs-io/cloudstruct-vm-frontend
Last synced: 6 months ago
JSON representation
CloudStruct Frontend for VM
- Host: GitHub
- URL: https://github.com/blinklabs-io/cloudstruct-vm-frontend
- Owner: blinklabs-io
- License: mit
- Created: 2022-12-16T16:30:58.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-02T12:02:54.000Z (about 1 year ago)
- Last Synced: 2024-05-02T19:24:36.833Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 8.88 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vm-frontend
Welcome to the CloudStruct VM Frontend!
## About
The code is split into two projects, an Express API which serves as a backend
for the frontend, and a React UI which is built into static assets.
This is intended for use via Docker.
Within this repository is an Ansible playbook to install Docker on the local
machine and run the containers. You can disable installing Docker by setting
`MANAGE_DOCKER=false` in `.env`.
## Usage
```bash
./runme.sh
```
## Dev usage
You can run `npm install` and `npm run` from the client, server, and root
folders as needed. The preferred way for testing us `npm run dev` from the
root folder. There's a readme on the client folder you should check out.
Project uses NPM version 16. Most accurate results are obtained runnning
the docker image.
### Logging
Access logging is enabled in the server. It uses Morgan and the type of logs
which are output can be controlled by setting `LOG_TYPE` to a valid Morgan
log type, such as `LOG_TYPE=combined` for Apache Combined Log Format.
### Mainnet
For Mainnet, you'll want to set the following variables to point to a mainnet
instance of the backends. Also, make sure API token (and PSK) matches mainnet.
```
AIRDROP_ENABLED=false
CARDANO_NETWORK=mainnet
KOIOS_URL=https://api.koios.rest/api/v0
VM_URL=https://vm.adaseal.eu
```