Clean up repo: add .gitignore, README, and modernize Docker setup #1

Closed
opened 2026-03-21 23:03:36 +00:00 by murray · 0 comments
Owner

Objective

This repo works but needs cleanup to be portfolio-ready. The Dockerfile and docker-compose exist but may be outdated. Docs are missing.

Current State

  • server.js — Express server with /process-template endpoint
  • Dockerfile + docker-compose.yml — exist, need review
  • package.json — present
  • No README, no .gitignore
  • .gitea/workflows/trigger-github.yml — old CI leftover from GitHub mirror, should be removed

Deliverables

1. Add .gitignore

node_modules/
.DS_Store
*.log
.env

2. Remove .gitea/workflows/trigger-github.yml

This was a GitHub Actions trigger from when this was a mirror. No longer relevant.

3. Review and update Dockerfile

  • Use node:20-alpine base
  • Multi-stage build if beneficial
  • Ensure it builds and runs correctly

4. Review and update docker-compose.yml

  • Sensible defaults for local dev
  • Health check if appropriate

5. Create README.md

Document:

  • What this service does (DOCX template processing via HTTP API)
  • API endpoint: POST /process-template
  • Request format (multipart: template file + data JSON field)
  • Response format
  • How to run locally (docker-compose up or npm start)
  • Environment variables (if any)

Git Setup

git clone https://gitea.netcups.al3dev.link/monkey-island/docxtemplater-server.git
cd docxtemplater-server
# ... make changes ...
git add -A && git commit -m "chore: clean up repo, add README and .gitignore" && git push

Use remote URL with token: https://otis:<GITEA_TOKEN>@gitea.netcups.al3dev.link/monkey-island/docxtemplater-server.git

The Gitea token is available in /root/.openclaw/workspace/.gitea-credentials.

Acceptance Criteria

  • .gitignore added
  • Old GitHub workflow removed
  • Dockerfile reviewed/updated
  • docker-compose.yml reviewed/updated
  • README.md with API docs
  • docker build . succeeds

When Done

Run: openclaw system event --text "Done: docxtemplater-server cleaned up in monkey-island/docxtemplater-server" --mode now

## Objective This repo works but needs cleanup to be portfolio-ready. The Dockerfile and docker-compose exist but may be outdated. Docs are missing. ## Current State - `server.js` — Express server with `/process-template` endpoint - `Dockerfile` + `docker-compose.yml` — exist, need review - `package.json` — present - No README, no .gitignore - `.gitea/workflows/trigger-github.yml` — old CI leftover from GitHub mirror, should be removed ## Deliverables ### 1. Add `.gitignore` ``` node_modules/ .DS_Store *.log .env ``` ### 2. Remove `.gitea/workflows/trigger-github.yml` This was a GitHub Actions trigger from when this was a mirror. No longer relevant. ### 3. Review and update Dockerfile - Use `node:20-alpine` base - Multi-stage build if beneficial - Ensure it builds and runs correctly ### 4. Review and update `docker-compose.yml` - Sensible defaults for local dev - Health check if appropriate ### 5. Create `README.md` Document: - What this service does (DOCX template processing via HTTP API) - API endpoint: `POST /process-template` - Request format (multipart: `template` file + `data` JSON field) - Response format - How to run locally (`docker-compose up` or `npm start`) - Environment variables (if any) ## Git Setup ```bash git clone https://gitea.netcups.al3dev.link/monkey-island/docxtemplater-server.git cd docxtemplater-server # ... make changes ... git add -A && git commit -m "chore: clean up repo, add README and .gitignore" && git push ``` Use remote URL with token: `https://otis:<GITEA_TOKEN>@gitea.netcups.al3dev.link/monkey-island/docxtemplater-server.git` The Gitea token is available in `/root/.openclaw/workspace/.gitea-credentials`. ## Acceptance Criteria - [ ] .gitignore added - [ ] Old GitHub workflow removed - [ ] Dockerfile reviewed/updated - [ ] docker-compose.yml reviewed/updated - [ ] README.md with API docs - [ ] `docker build .` succeeds ## When Done Run: `openclaw system event --text "Done: docxtemplater-server cleaned up in monkey-island/docxtemplater-server" --mode now`
murray added the
P2-normal
chore
otis
labels 2026-03-21 23:03:36 +00:00
murray reopened this issue 2026-03-21 23:07:48 +00:00
otis closed this issue 2026-03-21 23:11:54 +00:00
Sign in to join this conversation.
No description provided.