Repository navigation
Setup Guide
How to get OctoTasks running on your machine.
This repository uses GitHub pull requests and GitHub Actions.
- You will make changes on a branch, then open a PR for review.
- CI checks appear on the PR timeline/checks tab.
- Merges are controlled by repository rules and required checks.
| Tool | Version | Check |
|---|---|---|
| Git | 2.x+ | git --version |
| Node.js | 20+ | node --version |
| npm | 10+ | npm --version |
git clone https://github.com/<org>/training.git
cd training
npm installTip: if you normally work with SSH remotes, you can switch origin after cloning.
npm start
# OctoTasks running on http://localhost:3000Open http://localhost:3000. You should see a task list with five seed tasks.
npm testExpected output: 16 tests passed.
A coverage/ directory is generated — open coverage/lcov-report/index.html to see
line-by-line coverage.
npm run lintNo output means no errors.
npm run devThe server restarts automatically whenever you save a file.
- Create a branch:
git checkout -b docs/my-first-github-pr- Edit a wiki source file under
wiki/. - Commit and push your branch.
- Open a pull request.
- Wait for CI checks to pass, then merge.
After merge to main, wiki page updates are published automatically.
| Variable | Default | Description |
|---|---|---|
PORT |
3000 |
HTTP port to listen on |
Example:
PORT=8080 npm starttraining/
├── src/
│ ├── app.js # Express entry point
│ ├── store.js # In-memory task store
│ ├── routes/
│ │ └── tasks.js # /api/tasks REST routes
│ └── public/
│ ├── index.html # Frontend
│ ├── style.css # Styles
│ └── app.js # Frontend JavaScript
├── tests/
│ └── tasks.test.js # Jest test suite
├── docs/ # GitHub Pages documentation
└── walkthrough/ # Trainer guides
Port already in use
PORT=3001 npm startnpm install fails
Ensure you're on Node.js 20+: node --version. If you have nvm:
nvm install 20 && nvm use 20Tests fail with EADDRINUSE
The test suite imports the app module without starting the server (it uses
supertest), so port conflicts should not occur. If you see this error,
kill any running npm start process first.
I merged wiki changes but do not see updates on the GitHub Wiki
- Confirm the merge landed on
main. - Check the Sync GitHub Wiki workflow run in the Actions tab.
- Ensure the repository Wiki feature is enabled in settings.