Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 69 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,84 @@
# sv
# 💸 Finance

Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).
A simple, collaborative finance tracking app designed to help you stay on top of your money without the clutter.

## Creating a project
---

If you're seeing this, you've probably already done this step. Congrats!
## ✨ Overview

```sh
# create a new project
npx sv create my-app
```
**Finance** is a lightweight web app that allows users to manually track their income, expenses, and budget in one clean dashboard.

To recreate this project with the same configuration:
Built with simplicity in mind, it gives you just what you need—no unnecessary complexity, no overwhelming features.

```sh
# recreate this project
npx sv@0.12.5 create --template minimal --no-types --add prettier eslint tailwindcss="plugins:typography,forms" --install npm finance
```
---

## Developing
## 🚀 Features

Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
### 📊 Dashboard

```sh
npm run dev
- Clean, intuitive overview of your finances
- Track total income, expenses, and remaining budget
- Visual insights to understand your spending at a glance

# or start the server and open the app in a new browser tab
npm run dev -- --open
```
### 💰 Income Tracking

## Building
- Add and manage income entries
- Update values as needed over time

To create a production version of your app:
### 💸 Expense Tracking

```sh
npm run build
```
- Log and categorize expenses
- Edit or remove entries anytime

### 🧾 Budget Management

- Set a basic budget
- Monitor how close you are to your limit

### 🤝 Shared Accounts (Core Feature)

- Invite other users to your account
- Collaborate in real-time
- Shared users can:
- View all financial data
- Add/edit/delete income
- Add/edit/delete expenses
- Update the budget

> Perfect for couples, roommates, or teams managing shared finances.

---

## 🧠 Philosophy

You can preview the production build with `npm run preview`.
This app is intentionally **manual and minimal**.

> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
- No bank integrations
- No automation
- No hidden complexity

Just full control over your financial data, the way you want it.

---

## 🛠️ Tech Stack

- **Frontend:** SvelteKit (Svelte 5)
- **Styling:** Tailwind CSS
- **Backend / DB:** PocketBase
- **UI Components:** Custom + shadcn-inspired patterns

---

## 📦 Getting Started

```bash
# Clone the repo
git clone https://github.com/your-username/finance.git

# Install dependencies
npm install

# Start development server
npm run dev
```
8 changes: 6 additions & 2 deletions src/app.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,14 @@
<meta name="theme-color" content="#212020" />
<meta http-equiv="X-UA-Compatible" content="ie=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta property="og:title" content="Finance App" />
<meta property="og:site_name" content="https://finance-eight-fawn.vercel.app" />
<meta property="og:type" content="website" />
<meta property="og:image" content="/og-image.jpg" />
%sveltekit.head%
</head>
<body data-sveltekit-preload-data="hover">
<div class="hidden h-screen bg-grey-800 noscript:block"></div>
<div style="display: contents; height: 100%">%sveltekit.body%</div>
<div class="hidden h-dvh bg-grey-800 noscript:block"></div>
<div style="display: contents; height: 100dvh">%sveltekit.body%</div>
</body>
</html>
1 change: 1 addition & 0 deletions src/lib/assets/graphics/dark_logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
183 changes: 0 additions & 183 deletions src/lib/components/AccountAccess.svelte

This file was deleted.

45 changes: 0 additions & 45 deletions src/lib/components/AccountHistory.svelte

This file was deleted.

Loading