This repo contians Dockerfiles that define images for completing ZKU assignments. The aim of this project is to alleviate the pain of setting up dependencies in cross platform environments which very often results into issues that are dependend on the host environment.
The dependencies installed in this environment are:
- NodeJS v16.0.0
- circom (latest)
- cargo (latest stable)
This workspace comes only with the required dependencies for the assigments. The assignments themselves need to be cloned from the official ZKU repo.
WARNING: The provided command to launch the workspace container here mounts your current working directory to /home/student/workspace therefore everything stored in there will be persistent on your disk even after the container terminates. Any work saved on any other directory will be lost (due to the --rm flag)! You can change the mounted directory by modifying the -v option in the docker run ... command.
There are two possible ways of utilizing the Dockerfiles in this repository to launch an isolated environments with all the required dependencies pre-installed:
- Run locally using Docker engine
- Run on Gitpod
In order to run locally, it is necessary that you already have Docker engine installed on your machine.
Launch environment using the prebuilt image:
docker run -it --rm -v $(pwd):/home/student/workspace ghcr.io/apogiatzis/zku-assignment-workspace:latestNote that If you have already launched the container locally using the prebuilt image, the above command will use the image downloaded at that time. To make sure that you have the latest image run:
docker pull ghcr.io/apogiatzis/zku-assignment-workspace:latest
You can optionally rebuild the image in case of custom modifications or requirements in the Dockerfile. Otherwise this is not a necessary step as the image has already been built and pushed to Github's container registry. You can build the image locally using the following command:
docker build . <image-name>In order to run a container using the locally built image, ensure that the image name is replaced to the one used at the build stage. For instance:
docker build . my-zku-assignments-image
docker run -it --rm -v $(pwd):/home/student/workspace my-zku-assignments-image Alternatively, Gitpod environmet builds on top of the gitpod/workspace-base image. Gitpod provides a full fledged completely online IDE experience with a dedicated workspace. It is a great alternative if you don't want to install anything on your machine.
Note that running this in Gitpod requires authenticating using your Github account
To launch gitpod with this docker workspace click the button below:
