README.md

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, Prisma, Neon, Clerk, Resend, React Email and Shadcn/ui,
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.

.
├── src                          # Main project lives here
│    ├── actions                 # All server actions
│    ├── app                     # Main application
│    ├── components              # Components for the application
│    └── ...
├── 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 Neon Database Account
   2. Create Clerk Account

5. We now need to push the schema to the database

#To push Prisma to Neon DB
pnpm db:deploy

6. Start the development server from either yarn or turbo:

# To start the server
pnpm dev

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
• Prisma – Typescript-first ORM for Node.js
• React Email – Versatile email framework for efficient and flexible email development

Platforms

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

UI

• Shadcn/ui – Re-usable components built using Radix UI and Tailwind CSS
• MagicUI – Perfect to start any project with this template.
• Tailwind CSS – Utility-first CSS framework for rapid UI development
• Framer Motion – Motion library for React to animate components with ease
• Lucide – Beautifully simple, pixel-perfect icons

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