This is a code bundle for Household Budget Planner App. The original project is available at https://www.figma.com/design/jmQvNP4M2XLTQ9F8dFGsGS/Household-Budget-Planner-App.
Run npm i to install the dependencies.
Run npm run dev to start the development server.
Functional and technical documentation for this project is available in the docs/ folder.
docs/index.md- Documentation landing pagedocs/functional-specification.md- Functional documentationdocs/technical-specification.md- Technical documentationdocs/api-reference.md- API endpoint referencedocs/savings-goals-decision-note.md- Savings goals lifecycle and completed-state UX decision
- Push the repository to GitHub.
- In GitHub, open Settings > Pages.
- Under Build and deployment, select:
- Source: Deploy from a branch
- Branch:
main(or your default branch) - Folder:/docs - Save the settings and wait for GitHub Pages to publish.
The documentation site entry point is docs/index.md.