docs: add AGENTS.md with Cursor Cloud dev setup notes - #13
Merged
Conversation
Co-authored-by: darknessomi <darknessomi@users.noreply.github.com>
darknessomi
marked this pull request as ready for review
July 10, 2026 09:24
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Sets up the development environment for this YApi source deployment and documents the non-obvious cloud caveats in a new
AGENTS.md.Verified end-to-end in the cloud VM:
npm install, Node v22 which satisfiesengines: node >= 20).config.json(gitignored) pointing at127.0.0.1, and initialized the DB / admin viaserver/install.js.npm run dev-serveron :3000,npm run dev-clienton :4000).admin@admin.comand created a project "Hello World API".Notable gotcha captured in
AGENTS.md:server/yapi.jsresolvesWEBROOT_RUNTIMEto the filesystem root/in a source checkout, so/logand/init.locklive at/and need write access.Testing
npm run lintnpm test(60 passed)npm run dev-server+npm run dev-client(app reachable at http://127.0.0.1:3000)yapi_login_create_project.mp4
Hello World API project created
The update script is
npm install(snapshot-managed environment; MongoDB start andconfig.jsonare documented inAGENTS.mdrather than the update script).To show artifacts inline, enable in settings.