https://github.com/heliumedu/frontend
Fontend of Helium's planner application
https://github.com/heliumedu/frontend
calendar docker education frontend javascript jquery nodejs planner student webpack
Last synced: 3 months ago
JSON representation
Fontend of Helium's planner application
- Host: GitHub
- URL: https://github.com/heliumedu/frontend
- Owner: HeliumEdu
- License: mit
- Created: 2018-01-02T22:22:41.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2025-01-23T16:51:28.000Z (9 months ago)
- Last Synced: 2025-01-23T17:35:14.041Z (9 months ago)
- Topics: calendar, docker, education, frontend, javascript, jquery, nodejs, planner, student, webpack
- Language: JavaScript
- Homepage: https://www.heliumedu.com
- Size: 7.35 MB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/HeliumEdu/frontend/actions/workflows/build.yml)
# Helium Frontend
The `frontend` for [Helium Edu](https://www.heliumedu.com/).
Released container images are published to [Helium's AWS ECR](https://gallery.ecr.aws/heliumedu/).
## 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](https://webpack.js.org/) is being used in a very hacky way (for
instance, the generated bundle is useless and should be ignored), [Nunjucks](https://mozilla.github.io/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:
```sh
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:
```sh
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
```sh
make test
```
#### Image Architecture
By default, the Docker image will be built for `linux/arm64`. To build a native image on an `x86` architecture
instead, set `PLATFORM=amd64`.
### Platform
The backend `platform` is served from a separate repository and can be found [here](https://github.com/HeliumEdu/platform#readme).
Using Docker, the `frontend` and `platform` containers can be started alongside each other to almost entirely
emulate a `prod`-like environment locally using [the `deploy` project](https://github.com/HeliumEdu/deploy). For
functionality that still requires Internet-connected external services (ex. emails and text messages), provision
[the `dev-local` Terraform Workspace](https://github.com/HeliumEdu/deploy/tree/main/terraform/environments/dev-local),
which is meant to work alongside local Docker development.