Docs: Write setup and startup documentation #76
Merged
+177
−88
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Rewrite the README so someone can run the project from a fresh clone:database setup and import, backend, frontend. Replace "Planned Functionality" with what works now and what is still missing. Update AGENTS.md with the database commands, the folder structure and the backend settings on the VM. Fix docs/ci-cd.md, which still said there were no API tests. Closes #41
4 tasks
jonatsm
approved these changes
Oct 15, 2026
jonatsm
requested changes
Oct 15, 2026
There was a problem hiding this comment.
Nice! Some feedback that should be addressed:
- Rollback only works back to #73. Earlier runs have no production deployment and no deploy job, and runs before #70 don't deploy at all. Add a note saying re-run only works for deploys from #73 onward, and use a revert for anything older.
- The site check also loads the start page. The text says it only tests the backend and the database, which contradicts the step table above it. Correct the sentence.
- "There are no API tests" is outdated (finding 7). #74 added API and database tests. Update the section.
Sign in
to join this conversation on GitHub.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #41
What changed
README.md:AGENTS.md: added the database setup commands, updated the folder structure, and added the backend settings and rollback to the Deployment section.docs/ci-cd.md: fixed a line that said there were no API tests and thatnpm testskips the backend.Testing
npx prettier --check README.md AGENTS.md docs/ci-cd.md