Skip to content

JYOshiro/HouseholdBudgetPlanner

Repository files navigation

Household Budget Planner App

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.

Running the code

Run npm i to install the dependencies.

Run npm run dev to start the development server.

Documentation

Functional and technical documentation for this project is available in the docs/ folder.

  • docs/index.md - Documentation landing page
  • docs/functional-specification.md - Functional documentation
  • docs/technical-specification.md - Technical documentation
  • docs/api-reference.md - API endpoint reference
  • docs/savings-goals-decision-note.md - Savings goals lifecycle and completed-state UX decision

Publish Documentation with GitHub Pages

  1. Push the repository to GitHub.
  2. In GitHub, open Settings > Pages.
  3. Under Build and deployment, select: - Source: Deploy from a branch - Branch: main (or your default branch) - Folder: /docs
  4. Save the settings and wait for GitHub Pages to publish.

The documentation site entry point is docs/index.md.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages