Badget: Revolutionizing Financial Management

Empower your financial management with Badget - AI-driven insights at your fingertips. Optimize your finances effortlessly.

Introduction · Installation · Tech Stack + Features · Credits

Introduction

Welcome to Badget, where we're ushering in a new era of financial management. Leveraging cutting-edge AI, Badget redefines how you track, analyze, and optimize your finances, ensuring smarter, more secure financial decisions.

With Badget, gain unparalleled insights into your spending habits and financial patterns, empowering you to budget better and experience more. Trusted by the world's most innovative companies, Badget is here to revolutionize your financial management experience.

What we are using

Lets goooo - Next.js 14, Turborepo, Drizzle ORM, Planetscale, Clerk, Resend, React Email, Shadcn/ui, and Stripe.
All seamlessly integrated with the Badget to accelerate the development.

Directory Structure

Badget is a monorepo managed by Turborepo. The monorepo is split between apps and packages directories.

.
├── apps                         # Its app workspace which contains
│    ├── www                     # Nextjs app which is deployed in Vercel
│    └── ...
├── packages                     # are the shared packages that are used by the apps (e.g. `@badget/api`)
├── plugins                      # are the connectors that are used to connect to open-finance data (e.g. `@badget/connector-plaid`)
├── tooling                      # are the shared configuration that are used by the apps and packages (e.g. `@badget/eslint-config`)
├── docker-compose.yml
├── LICENSE
└── README.md

Use short lowercase names at least for the top-level files and folders except LICENSE, README.md

Installation

Clone & create this repo locally with the following command:

git clone https://github.com/projectx-codehagen/Badget

Install dependencies using pnpm:

pnpm install

Copy .env.example to .env.local and update the variables.

cp .env.example .env.local

Input everything you need for the env.
1. Create Clerk Account
2. Create Neon Account
3. Create Stripe Account and download Stripe CLI
Start the development server from either yarn or turbo:

# At the root of the mono repo
pnpm run dev:web

Stripe

To set up Stripe locally with environment variables:

Create a Stripe account.
After signing in, go to the dashboard and switch to Test mode.
In the dashboard, switch to the API keys section.
Reveal your secret key and paste it into your .env.local file.
For the webhook key, switch to the Webhooks tab, add an endpoint to reveal the secret key.
To get the PRODUCT_ID and PRICE_ID, head over to Stripe's API Docs.
From the docs, use the API with your STRIPE_API_KEY to create a product & price object.
The response object from the API contains two keys: id and product.
Use the id as your PRICE_ID and product as your PRODUCT_ID.
You can use the same keys for the STD and PRO variables.

Database

This project uses Postgres database on Neon. To setup a DB for your local dev:

Create a free account and a new Database

Roadmap

~~Initial setup~~
Start removing template
Update UI to match the product
Start stichting frontend with backend

Tech Stack + Features

Frameworks

Next.js – React framework for building performant apps with the best developer experience
Clerk – Handle user authentication with ease with providers like Google, Twitter, GitHub, etc.
Drizzle ORM – TypeScript ORM that feels like SPA with SSR
React Email – Versatile email framework for efficient and flexible email development

Platforms

Vercel – Easily preview & deploy changes with git
PlanetScale – A cutting-edge database platform for seamless, scalable data management
Resend – A powerful email framework for streamlined email development
Stripe - Payments

UI

Tailwind CSS – Utility-first CSS framework for rapid UI development
Shadcn/ui – Re-usable components built using Radix UI and Tailwind CSS
Framer Motion – Motion library for React to animate components with ease
Lucide – Beautifully simple, pixel-perfect icons
next/font – Optimize custom fonts and remove external network requests for improved performance
ImageResponse – Generate dynamic Open Graph images at the edge

Contributing

We love our contributors! Here's how you can contribute:

Open an issue if you believe you've encountered a bug.
Make a pull request to add new features/make quality-of-life improvements/fix bugs.

RickyRAV/Badget