Sure! Below is a README file for your "Spend Smart" budget tracker project:
Spend Smart is a full-stack budget tracker application designed to help users manage their finances efficiently. Built with modern web technologies, Spend Smart offers a seamless experience for tracking transactions, analyzing spending habits, and visualizing financial data.
- Transaction Management: Add, edit, and delete transactions with ease.
- Category Statistics: View aggregated data by category to understand spending patterns.
- Historical Data Aggregates: Analyze financial data over time for better insights.
- Stunning Charts: Visualize financial data using interactive charts.
- Icon Selector for Categories: Customize categories with unique icons for better organization.
- Next.js 14: Framework for server-rendered React applications.
- TypeScript: Adds type safety to JavaScript.
- Tailwind CSS: Utility-first CSS framework for rapid UI development.
- Shadcn UI: Component library for Next.js and Tailwind CSS.
- Recharts: Charting library for React.
- React Query: Data-fetching library to manage server state.
- Next.js 14 API Routes: For building the API endpoints.
- ServerActions: For handling server-side logic.
- SQLite / Vercel PostgreSQL: Database for storing data.
- Prisma: ORM for database operations.
- Clerk: Authentication and user management.
- Node.js (v14 or higher)
- npm or yarn
-
Clone the repository:
git clone https://github.com/goku-raj/spendSmart cd spend-smart
-
Install dependencies:
npm install # or yarn install
-
Set up environment variables: Create a
.env
file in the root directory and add your Clerk API keys and database connection strings. -
Set up the database:
npx prisma migrate dev --name init
-
Run the development server:
npm run dev # or yarn dev
-
Open http://localhost:3000 in your browser to see the app.
- Navigate to the Transactions page to add, edit, or delete transactions.
- Use the form to input transaction details such as amount, category, and date.
- View statistics aggregated by category to understand your spending patterns.
- Filter transactions by category to drill down into specific spending areas.
- Analyze your financial data over time.
- Use the charts to see trends and patterns in your spending habits.
- Navigate to the Charts page to visualize your financial data.
- Use different chart types to get a better understanding of your finances.
- Customize categories with unique icons.
- Choose from a library of icons to make your categories visually distinct.