Clean up repo: remove committed node_modules, add .gitignore and README #1

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

Objective

This repo has node_modules/ committed to git (!) and is missing docs. Clean it up to be portfolio-ready.

Current State

  • src/server.js — Express PDF processing server (split, rename based on metadata)
  • package.json — Dependencies: express, multer, pdf-lib, archiver, joi
  • Dockerfile + docker-compose.yml — exist
  • ⚠️ node_modules/ is committed to git — needs to be removed and gitignored
  • No README, no .gitignore
  • .DS_Store committed

Deliverables

1. Remove node_modules/ from git

git rm -r --cached node_modules/
git rm --cached .DS_Store

2. Add .gitignore

node_modules/
.DS_Store
*.log
.env
uploads/

3. Review and update Dockerfile

  • Use node:20-alpine base
  • Ensure npm install runs in the build step
  • Ensure it builds correctly

4. Review and update docker-compose.yml

  • Sensible defaults for local dev

5. Create README.md

Document:

  • What this service does (PDF processing: split and rename based on metadata)
  • API endpoints (read src/server.js to discover them)
  • Request/response formats
  • How to run locally (docker-compose up or npm start)
  • Dependencies

Git Setup

git clone https://gitea.netcups.al3dev.link/monkey-island/pdf-manager.git
cd pdf-manager
# ... make changes ...
git add -A && git commit -m "chore: remove node_modules, add .gitignore and README" && git push

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

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

Acceptance Criteria

  • node_modules/ removed from git history (at least from tracking)
  • .DS_Store removed
  • .gitignore added
  • Dockerfile reviewed/updated
  • docker-compose.yml reviewed/updated
  • README.md with API docs
  • docker build . succeeds

When Done

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

## Objective This repo has `node_modules/` committed to git (!) and is missing docs. Clean it up to be portfolio-ready. ## Current State - `src/server.js` — Express PDF processing server (split, rename based on metadata) - `package.json` — Dependencies: express, multer, pdf-lib, archiver, joi - `Dockerfile` + `docker-compose.yml` — exist - **⚠️ `node_modules/` is committed to git** — needs to be removed and gitignored - No README, no .gitignore - `.DS_Store` committed ## Deliverables ### 1. Remove `node_modules/` from git ```bash git rm -r --cached node_modules/ git rm --cached .DS_Store ``` ### 2. Add `.gitignore` ``` node_modules/ .DS_Store *.log .env uploads/ ``` ### 3. Review and update Dockerfile - Use `node:20-alpine` base - Ensure `npm install` runs in the build step - Ensure it builds correctly ### 4. Review and update `docker-compose.yml` - Sensible defaults for local dev ### 5. Create `README.md` Document: - What this service does (PDF processing: split and rename based on metadata) - API endpoints (read `src/server.js` to discover them) - Request/response formats - How to run locally (`docker-compose up` or `npm start`) - Dependencies ## Git Setup ```bash git clone https://gitea.netcups.al3dev.link/monkey-island/pdf-manager.git cd pdf-manager # ... make changes ... git add -A && git commit -m "chore: remove node_modules, add .gitignore and README" && git push ``` Use remote URL with token: `https://otis:<GITEA_TOKEN>@gitea.netcups.al3dev.link/monkey-island/pdf-manager.git` The Gitea token is available in `/root/.openclaw/workspace/.gitea-credentials`. ## Acceptance Criteria - [ ] `node_modules/` removed from git history (at least from tracking) - [ ] `.DS_Store` removed - [ ] `.gitignore` added - [ ] Dockerfile reviewed/updated - [ ] docker-compose.yml reviewed/updated - [ ] README.md with API docs - [ ] `docker build .` succeeds ## When Done Run: `openclaw system event --text "Done: pdf-manager cleaned up in monkey-island/pdf-manager" --mode now`
murray added the
P1-high
chore
otis
labels 2026-03-21 23:03:49 +00:00
murray reopened this issue 2026-03-21 23:07:53 +00:00
Sign in to join this conversation.
No description provided.