Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/sanidhyy/finance-dashboard

Track your income and expenses with Finance.
https://github.com/sanidhyy/finance-dashboard
clerk drizzle-orm finance finance-management honojs next react reactjs recharts shadcn-ui tailwindcss typescript
Last synced: about 2 months ago
JSON representation
Track your income and expenses with Finance.
Host: GitHub
URL: https://github.com/sanidhyy/finance-dashboard
Owner: sanidhyy
License: mit
Created: 2024-05-11T02:32:53.000Z (8 months ago)
Default Branch: main
Last Pushed: 2024-10-04T06:23:44.000Z (3 months ago)
Last Synced: 2024-10-25T10:37:03.537Z (about 2 months ago)
Topics: clerk, drizzle-orm, finance, finance-management, honojs, next, react, reactjs, recharts, shadcn-ui, tailwindcss, typescript
Language: TypeScript
Homepage: https://appfinance.vercel.app/
Size: 2.05 MB
Stars: 16
Watchers: 2
Forks: 4
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project

README

        

# Track your income and expenses with Finance.

![Track your income and expenses with Finance.](/.github/images/img_main.png "Track your income and expenses with Finance.")

[![Ask Me Anything!](https://flat.badgen.net/static/Ask%20me/anything?icon=github&color=black&scale=1.01)](https://github.com/sanidhyy "Ask Me Anything!")

[![GitHub license](https://flat.badgen.net/github/license/sanidhyy/finance-dashboard?icon=github&color=black&scale=1.01)](https://github.com/sanidhyy/finance-dashboard/blob/main/LICENSE "GitHub license")

[![Maintenance](https://flat.badgen.net/static/Maintained/yes?icon=github&color=black&scale=1.01)](https://github.com/sanidhyy/finance-dashboard/commits/main "Maintenance")

[![GitHub branches](https://flat.badgen.net/github/branches/sanidhyy/finance-dashboard?icon=github&color=black&scale=1.01)](https://github.com/sanidhyy/finance-dashboard/branches "GitHub branches")

[![Github commits](https://flat.badgen.net/github/commits/sanidhyy/finance-dashboard?icon=github&color=black&scale=1.01)](https://github.com/sanidhyy/finance-dashboard/commits "Github commits")

[![GitHub issues](https://flat.badgen.net/github/issues/sanidhyy/finance-dashboard?icon=github&color=black&scale=1.01)](https://github.com/sanidhyy/finance-dashboard/issues "GitHub issues")

[![GitHub pull requests](https://flat.badgen.net/github/prs/sanidhyy/finance-dashboard?icon=github&color=black&scale=1.01)](https://github.com/sanidhyy/finance-dashboard/pulls "GitHub pull requests")

[![Vercel status](https://img.shields.io/badge/Vercel-000000?style=for-the-badge&logo=vercel&logoColor=white)](https://appfinance.vercel.app/ "Vercel status")

# :notebook_with_decorative_cover: Table of Contents

- [Folder Structure](#bangbang-folder-structure)

- [Getting Started](#toolbox-getting-started)

- [Screenshots](#camera-screenshots)

- [Tech Stack](#gear-tech-stack)

- [Stats](#wrench-stats)

- [Contribute](#raised_hands-contribute)

- [Acknowledgements](#gem-acknowledgements)

- [Buy Me a Coffee](#coffee-buy-me-a-coffee)

- [Follow Me](#rocket-follow-me)

- [Learn More](#books-learn-more)

- [Deploy on Vercel](#page_with_curl-deploy-on-vercel)

- [Give A Star](#star-give-a-star)

- [Star History](#star2-star-history)

- [Give A Star](#star-give-a-star)

## :bangbang: Folder Structure

Here is the folder structure of this app.

```bash

finance-dashboard/

  |- app/

    |-- (auth)/

    |-- (dashboard)/

    |-- api/

    |-- apple-icon.png

    |-- favicon.ico

    |-- globals.css

    |-- icon1.png

    |-- icon2.png

    |-- layout.tsx

  |- components/

    |-- ui/

  |- config/

    |-- index.ts

  |- db/

    |-- drizzle.ts

    |-- schema.ts

  |- drizzle/

  |- features/

    |-- accounts/

    |-- categories/

    |-- summary/

    |-- transactions/

  |- hooks/

    |-- use-confirm.tsx

  |- lib/

    |-- hono.ts

    |-- utils.ts

  |- providers/

    |-- query-provider.tsx

    |-- sheet-provider.tsx

  |- public/

    |-- data.csv

    |-- github.svg

    |-- logo.svg

  |- scripts/

    |-- seed.ts

  |- .env.example

  |- .env.local

  |- .eslintrc.json

  |- .gitignore

  |- .prettierrc

  |- bun.lockb

  |- components.json

  |- drizzle.config.ts

  |- environment.d.ts

  |- middleware.ts

  |- next.config.mjs

  |- package-lock.json

  |- package.json

  |- postcss.config.js

  |- tailwind.config.ts

  |- tsconfig.json

```




## :toolbox: Getting Started

1. Make sure **Git** and **NodeJS** is installed.

2. Clone this repository to your local computer.

3. Create `.env.local` file in **root** directory.

4. Contents of `.env.local`:

```env

# .env.local

# disabled next.js telemetry

NEXT_TELEMETRY_DISABLED=1

# clerk auth keys

NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=pk_test_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

CLERK_PUBLISHABLE_KEY=pk_test_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

CLERK_SECRET_KEY=sk_test_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

# clerk redirect url

NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in

NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up

# neon db url

DATABASE_URL=postgresql://:@/?sslmode=require

# app base url

NEXT_PUBLIC_APP_URL=http://localhost:3000

```

5. Obtain Clerk Authentication Keys

   1. **Source**: Clerk Dashboard or Settings Page

   2. **Procedure**:

      - Log in to your Clerk account.

      - Navigate to the dashboard or settings page.

      - Look for the section related to authentication keys.

      - Copy the `NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY` and `CLERK_SECRET_KEY` provided in that section.

6. Retrieve Neon Database URI

   1. **Source**: Database Provider (e.g., Neon, PostgreSQL)

   2. **Procedure**:

      - Access your database provider's platform or configuration.

      - Locate the database connection details.

      - Replace ``, ``, ``, and `` placeholders in the URI with your actual database credentials.

      - Ensure to include `?sslmode=require` at the end of the URI for SSL mode requirement.

7. Specify Public App URL

   1. **Procedure**:

      - Replace `http://localhost:3000` with the URL of your deployed application.

8. Save and Secure:

   - Save the changes to the `.env.local` file.

9. Install Project Dependencies using `npm install --legacy-peer-deps` or `yarn install --legacy-peer-deps`.

10. Migrate database:

In terminal, run `npm run db:generate` to generate database client and `npm run db:migrate` to make sure that your database is up-to-date along with schema.

11. Run the Seed Script:

In the same terminal, run the following command to execute the seed script:

```bash

npm run db:seed

```

This command uses `npm` to execute the Typescript file (`scripts/seed.ts`) and writes transaction data in database.

12. Verify Data in Database:

Once the script completes, check your database to ensure that the transaction data has been successfully seeded.

13. Now app is fully configured 👍 and you can start using this app using either one of `npm run dev` or `yarn dev`.

**NOTE:** Please make sure to keep your API keys and configuration values secure and do not expose them publicly.

## :camera: Screenshots

![Modern UI/UX](/.github/images/img1.png "Modern UI/UX")

![Transactions](/.github/images/img2.png "Transactions")

![Accounts](/.github/images/img3.png "Accounts")

## :gear: Tech Stack

[![React JS](https://skillicons.dev/icons?i=react "React JS")](https://react.dev/ "React JS") [![Next JS](https://skillicons.dev/icons?i=next "Next JS")](https://nextjs.org/ "Next JS") [![Typescript](https://skillicons.dev/icons?i=ts "Typescript")](https://www.typescriptlang.org/ "Typescript") [![Tailwind CSS](https://skillicons.dev/icons?i=tailwind "Tailwind CSS")](https://tailwindcss.com/ "Tailwind CSS") [![Vercel](https://skillicons.dev/icons?i=vercel "Vercel")](https://vercel.app/ "Vercel") [![Postgresql](https://skillicons.dev/icons?i=postgres "Postgresql")](https://www.postgresql.org/ "Postgresql")

## :wrench: Stats

[![Stats for Finance](/.github/images/stats.svg "Stats for Finance")](https://pagespeed.web.dev/analysis?url=https://appfinance.vercel.app/ "Stats for Finance")

## :raised_hands: Contribute

You might encounter some bugs while using this app. You are more than welcome to contribute. Just submit changes via pull request and I will review them before merging. Make sure you follow community guidelines.

## :gem: Acknowledgements

Useful resources and dependencies that are used in Finance.

- Thanks to CodeWithAntonio: https://codewithantonio.com/

- [@clerk/backend](https://www.npmjs.com/package/@clerk/backend): ^1.1.3

- [@clerk/nextjs](https://www.npmjs.com/package/@clerk/nextjs): ^5.0.8

- [@hono/clerk-auth](https://www.npmjs.com/package/@hono/clerk-auth): ^2.0.0

- [@hono/zod-validator](https://www.npmjs.com/package/@hono/zod-validator): ^0.2.1

- [@hookform/resolvers](https://www.npmjs.com/package/@hookform/resolvers): ^3.3.4

- [@neondatabase/serverless](https://www.npmjs.com/package/@neondatabase/serverless): ^0.9.3

- [@paralleldrive/cuid2](https://www.npmjs.com/package/@paralleldrive/cuid2): ^2.2.2

- [@radix-ui/react-checkbox](https://www.npmjs.com/package/@radix-ui/react-checkbox): ^1.0.4

- [@radix-ui/react-dialog](https://www.npmjs.com/package/@radix-ui/react-dialog): ^1.0.5

- [@radix-ui/react-dropdown-menu](https://www.npmjs.com/package/@radix-ui/react-dropdown-menu): ^2.0.6

- [@radix-ui/react-label](https://www.npmjs.com/package/@radix-ui/react-label): ^2.0.2

- [@radix-ui/react-popover](https://www.npmjs.com/package/@radix-ui/react-popover): ^1.0.7

- [@radix-ui/react-select](https://www.npmjs.com/package/@radix-ui/react-select): ^2.0.0

- [@radix-ui/react-separator](https://www.npmjs.com/package/@radix-ui/react-separator): ^1.0.3

- [@radix-ui/react-slot](https://www.npmjs.com/package/@radix-ui/react-slot): ^1.0.2

- [@radix-ui/react-tooltip](https://www.npmjs.com/package/@radix-ui/react-tooltip): ^1.0.7

- [@tanstack/react-query](https://www.npmjs.com/package/@tanstack/react-query): ^5.35.5

- [@tanstack/react-table](https://www.npmjs.com/package/@tanstack/react-table): ^8.16.0

- [class-variance-authority](https://www.npmjs.com/package/class-variance-authority): ^0.7.0

- [clsx](https://www.npmjs.com/package/clsx): ^2.1.1

- [date-fns](https://www.npmjs.com/package/date-fns): ^3.6.0

- [drizzle-orm](https://www.npmjs.com/package/drizzle-orm): ^0.30.10

- [drizzle-zod](https://www.npmjs.com/package/drizzle-zod): ^0.5.1

- [hono](https://www.npmjs.com/package/hono): ^4.3.4

- [lucide-react](https://www.npmjs.com/package/lucide-react): ^0.378.0

- [next](https://www.npmjs.com/package/next): 14.2.3

- [next-themes](https://www.npmjs.com/package/next-themes): ^0.3.0

- [query-string](https://www.npmjs.com/package/query-string): ^9.0.0

- [react](https://www.npmjs.com/package/react): ^18

- [react-countup](https://www.npmjs.com/package/react-countup): ^6.5.3

- [react-currency-input-field](https://www.npmjs.com/package/react-currency-input-field): ^3.8.0

- [react-day-picker](https://www.npmjs.com/package/react-day-picker): ^8.10.1

- [react-dom](https://www.npmjs.com/package/react-dom): ^18

- [react-hook-form](https://www.npmjs.com/package/react-hook-form): ^7.51.4

- [react-icons](https://www.npmjs.com/package/react-icons): ^5.2.1

- [react-papaparse](https://www.npmjs.com/package/react-papaparse): ^4.4.0

- [react-select](https://www.npmjs.com/package/react-select): ^5.8.0

- [react-use](https://www.npmjs.com/package/react-use): ^17.5.0

- [recharts](https://www.npmjs.com/package/recharts): ^2.12.7

- [sonner](https://www.npmjs.com/package/sonner): ^1.4.41

- [tailwind-merge](https://www.npmjs.com/package/tailwind-merge): ^2.3.0

- [tailwindcss-animate](https://www.npmjs.com/package/tailwindcss-animate): ^1.0.7

- [zod](https://www.npmjs.com/package/zod): ^3.23.8

- [zustand](https://www.npmjs.com/package/zustand): ^4.5.2

- [@types/node](https://www.npmjs.com/package/@types/node): ^20

- [@types/react](https://www.npmjs.com/package/@types/react): ^18

- [@types/react-dom](https://www.npmjs.com/package/@types/react-dom): ^18

- [dotenv](https://www.npmjs.com/package/dotenv): ^16.4.5

- [drizzle-kit](https://www.npmjs.com/package/drizzle-kit): ^0.21.2

- [eslint](https://www.npmjs.com/package/eslint): ^8

- [eslint-config-next](https://www.npmjs.com/package/eslint-config-next): 14.2.3

- [eslint-plugin-unused-imports](https://www.npmjs.com/package/eslint-plugin-unused-imports): ^3.2.0

- [pg](https://www.npmjs.com/package/pg): ^8.11.5

- [postcss](https://www.npmjs.com/package/postcss): ^8

- [prettier](https://www.npmjs.com/package/prettier): ^3.2.5

- [prettier-plugin-tailwindcss](https://www.npmjs.com/package/prettier-plugin-tailwindcss): ^0.5.14

- [tailwindcss](https://www.npmjs.com/package/tailwindcss): ^3.4.1

- [typescript](https://www.npmjs.com/package/typescript): ^5

## :coffee: Buy Me a Coffee

[](https://www.buymeacoffee.com/sanidhy "Buy me a Coffee")

## :rocket: Follow Me

[![Follow Me](https://img.shields.io/github/followers/sanidhyy?style=social&label=Follow&maxAge=2592000)](https://github.com/sanidhyy "Follow Me")

[![Tweet about this project](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Ftwitter.com%2FTechnicalShubam)](https://twitter.com/intent/tweet?text=Check+out+this+amazing+app:&url=https%3A%2F%2Fgithub.com%2Fsanidhyy%2Ffinance-dashboard "Tweet about this project")

[![Subscribe to my YouTube Channel](https://img.shields.io/youtube/channel/subscribers/UCNAz_hUVBG2ZUN8TVm0bmYw)](https://www.youtube.com/@OPGAMER./?sub_confirmation=1 "Subscribe to my YouTube Channel")

## :books: Learn More

To learn more about Next.js, take a look at the following resources:

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.

- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!

## :page_with_curl: Deploy on Vercel

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.

Check out [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.

## :star: Give A Star

You can also give this repository a star to show more people and they can use this repository.

## :star2: Star History



  

  

  






(back to top)