Skip to content

Latest commit

 

History

History
55 lines (38 loc) · 2.36 KB

README.md

File metadata and controls

55 lines (38 loc) · 2.36 KB
Raw

Build GitHub License

Helium Frontend Project

Prerequisites

  • Docker
  • Node (>= 18)

Getting Started

Note that this project is largely a placeholder. It was used to split out frontend code from the backend platform while the frontend code would be rewritten in React. However, as the project is no longer actively maintained, there is no current plant for this redevelopment. So, be aware that Webpack is being used in a very hacky way (for instance, the generated bundle is useless and should be ignored), Nunjucks, is being used to process HTML templates, and ultimately, this is legacy code that, if the project ever goes back in to active development, would be completely overhauled.

Development

Docker Setup

To provision the Docker container with the frontend build, execute:

bin/runserver

This builds and starts a container named helium_frontend. Once running, the frontend is available at http://localhost:3000. The shell of containers can be accessed with:

docker exec -it frontend-frontend-1 /bin/bash

Note that, since part of the way this build was hacked together circumvents many of Webpack's most useful features, live changes will not be detected at this time and would require a restart of this server.

Before commits are made, be sure to run tests and check the generated coverage report

make test

Platform

The backend platform is served from a separate repository and can be found here. Using Docker, the frontend and platform containers can be started alongside each other using to almost entirely emulate a prod-like environment locally using the deploy project. For functionality that still requires Internet-connected external services (ex. emails and text messages), provision the dev-local Terraform Workspace, which is meant to work alongside local Docker development.