From 27d9d8a61fc84d641dc415cafd2e9a854b58c85f Mon Sep 17 00:00:00 2001 From: Devon Campbell Date: Mon, 20 Oct 2025 01:04:05 -0400 Subject: [PATCH] Add basic documentation --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..351e113 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# WorkIt + +A PWA for creating and running workouts + +## Local Setup & Testing + +1. Clone the repository. +2. Run `dev.sh` +3. Run `docker run -p 8080:80 workit:latest` +4. Visit `http://localhost:8080` + +## Deployment to Portainer + +1. Build the image locally using `build.sh` from the project directory. +2. From > Images, click the "Import" button at the top of the image table +3. Select and upload the compressed file produced in step 2 +4. Incorporate the image into a docker-compose with `image: workit:latest`. If a stack is already deployed using the image, you can simply open that stack, edit, and click the "Update the Stack" button without making any changes to the compose file to deploy the latest image. The service is currently deployed in the "workit" stack. + +You may then optionally delete the old orphaned version of the image.