Skip to content

Document the local development bootstrap flow for the backend - #1082

Merged
Junirezz merged 5 commits into
Junirezz:mainfrom
Jumongweb:main
Jul 29, 2026
Merged

Document the local development bootstrap flow for the backend#1082
Junirezz merged 5 commits into
Junirezz:mainfrom
Jumongweb:main

Conversation

@Jumongweb

Copy link
Copy Markdown
Contributor

Summary

Document the local development bootstrap flow for the backend, smart contracts, and frontend so contributors can start the full stack with repo-accurate steps and environment expectations.

Closes #1057

What Changed

  • rewrote docs/LOCAL_DEVELOPMENT_QUICKSTART.md to reflect the actual local bootstrap path
  • updated the root README.md quick start to point to the supported backend/frontend/contracts flow
  • updated backend/README.md with Prisma migration setup and default SQLite/in-memory local behavior
  • replaced the stock Vite template content in frontend/README.md with project-specific setup instructions

Notes

  • documented that the default backend local path uses Prisma with SQLite when DATABASE_URL is unset
  • documented that Redis-backed features fall back to in-memory behavior when REDIS_URL is unset
  • clarified that real contract-backed flows require matching VAULT_CONTRACT_ID values in backend and frontend env files
  • made contract setup explicit but optional for contributors who are not changing on-chain code

Validation

  • cd backend && npm test -- --runInBand
    • fails on existing backend test issues in src/__tests__/pagination.test.ts and src/__tests__/issues481-484.test.ts
  • cd frontend && npm run test:run
    • fails in the current environment because vitest is not installed
  • cargo test
    • started successfully and entered compilation, but did not complete before wrap-up

Documentation Updated

  • docs/LOCAL_DEVELOPMENT_QUICKSTART.md
  • README.md
  • backend/README.md
  • frontend/README.md

@drips-wave

drips-wave Bot commented Jul 29, 2026

Copy link
Copy Markdown

@Jumongweb Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@Junirezz
Junirezz merged commit 107ea8b into Junirezz:main Jul 29, 2026
8 of 13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation: Document local dev bootstrap for backend, contracts, and frontend

2 participants