Devon/WorkIt
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add basic documentation

Browse source
This commit is contained in:
Devon Campbell 2025-10-20 01:04:05 -04:00
commit 27d9d8a61f
1 changed files with 19 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

19
README.md Normal file
View file

@ -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 <Environment> > 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.