https://github.com/bkarthik7/budgetnest
https://github.com/bkarthik7/budgetnest
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/bkarthik7/budgetnest
- Owner: BKarthik7
- Created: 2025-02-22T18:11:29.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-02-22T18:11:42.000Z (8 months ago)
- Last Synced: 2025-02-22T19:24:19.759Z (8 months ago)
- Language: JavaScript
- Size: 238 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BudgetNest
BudgetNest is a React Native mobile application for personal finance management, offering expense tracking, budget overviews, and visual financial analytics through interactive charts.
## Table of Contents
- [Features](#features)
- [Technology Stack](#technology-stack)
- [Installation](#installation)
- [Configuration](#configuration)
- [Running the App](#running-the-app)
- [Contributing](#contributing)
## Features
- **Financial Overview**: Dashboard with current balance and recent transactions
- **Expense Tracking**: Add/Edit/Delete income and expense records
- **Visual Analytics**: Interactive charts for spending patterns
- **Monthly Budgeting**: Set and track monthly budgets
- **Category Management**: Manage income and expense categories
- **Calendar View**: View transactions in a calendar format
- **Summary View**: Summary of income, expenses, and savings
## Technology Stack
### Frontend
- **React Native** - Cross-platform mobile framework
- **React Navigation** - Screen navigation management
- **React Native Vector Icons** - Icon library
- **React Native SVG Charts** - for PieChart
### Backend
- **Node.js** - Runtime environment
- **Express.js** - REST API framework
- **MongoDB** - NoSQL database
- **Mongoose** - MongoDB object modeling
### Utilities
- **Axios** - HTTP client
- **Moment.js** - Date/time manipulation
- **Dotenv** - Environment variable management
## Installation
### 1. Clone Repository
```bash
git clone https://github.com/yourusername/BudgetNest.git
cd BudgetNest
```
### 2. Install Frontend Dependencies
```bash
npm install
```
### 3. Install Backend Dependencies
```bash
cd api
npm install
cd ..
```
## Configuration
### Backend Setup
1. Create `.env` in `/api` directory:
```env
MONGODB_URL=mongodb+srv://:@cluster0.ikel3.mongodb.net/
PORT=8000
```
*Replace url with your MongoDB credentials*
### Frontend Setup
1. Create `.env` in root directory:
```env
REACT_APP_BACKEND_URL=http://localhost:8000
```
*For Android emulator, use `http://:8000` instead of localhost*
## Running the App
### Start Backend Server
```bash
cd api
npm start
```
### Start React Native Application
In a new terminal:
```bash
npx react-native run-android
# or for iOS
npx react-native run-ios
```
In another terminal:
```bash
npx react-native start
```
## Contributing
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
**Note**: This application requires an active internet connection for MongoDB Atlas integration.