liqwik / badget

Badget aims to simplify financial management with a user-friendly interface and robust backend

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

1. Install dependencies using pnpm:

pnpm install

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

cp .env.example .env.local

4. Input everything you need for the env.

   1. Create Clerk Account
   2. Create Planet Scale Account
   3. Create Resend Account
   4. Create Stripe Account and download Stripe CLI
   5. Create Edge Store Account
   6. Secure CRON jobs

5. 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:

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

Database

This project uses MySQL database on PlanetScale. To setup a DB for your local dev:

1. Create a free account and a new Database
2. From the dashboard, create a branch and click "Connect" button.
3. Hit Create password and select Drizzle in Connect with dropdown
4. Copy the entire list of params to .env.local file. Make sure to change the params under the section "Database (MySQL - PlanetScale)"
5. run pnpm run db:push

You can also use docker-compose to have a Mysql database locally, instead of relying on PlanetScale:

1. Enter MYSQL_ROOT_PASSWORD, MYSQL_DATABASE, MYSQL_USER and MYSQL_PASSWORD values in .env.local.
2. run docker-compose --env-file .env.local up to start the DB.
3. run pnpm run db:push.

Email provider

This project uses Resend to handle transactional emails. You need to add create an account and get an api key needed for authentication.

Please be aware that the Resend is designed to send test emails exclusively to the email address registered with the account, or to [email protected], where they are logged on their dashboard.

The default setting for TEST_EMAIL_ADDRESS is [email protected] but you have the option to change it to the email address that is associated with your Resend account.

Roadmap

• Initial setup
• Start removing template
• Update UI to match the product
• XXXXXXXX

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
• Edge Store - Storage, CDN and a super easy to use type-safe library.
• 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.

Repo Activity