Skip to content

Commit

Permalink
added readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
animesh156 committed Nov 18, 2024
1 parent f4d92d8 commit 3e2cf6c
Show file tree
Hide file tree
Showing 4 changed files with 124 additions and 1 deletion.
100 changes: 100 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@

# Expense Tracker App

The Expense Tracker App is a full-stack application that helps users manage their finances by tracking income and expenses. It offers features like adding, editing, and deleting transactions, visualizing data with charts, and categorizing transactions for better financial insights.

## Features

- #### Dashboard Overview: Get an overview of your income, expenses, and balance.

- #### Add Transactions: Record your income and expenses effortlessly

- #### Edit/Delete Transactions: Modify or remove entries to keep your records accurate.

- #### Transaction Categories: Organize transactions by categories (e.g., Food, Rent, Salary, etc.).

- #### Secure User Authentication: Users can securely log in and manage their personal finances.


## Run Locally

Clone the project

```bash
git clone https://github.com/animesh156/Expensy.git


```

Go to the project directory

```bash
cd expense-tracker
```

Install dependencies

```bash
cd client
npm install
```
```bash
cd ../server
npm install
```

Set up environment variables

```bash
MONGO_URI=<your-mongodb-connection-string>
JWT_SECRET=<your-jwt-secret>
```


Start the server

```bash
client
npm run dev
```
```bash
server
node index.js
```
Open your browser and navigate to:

```bash
http://localhost:3000
```



## Tech Stack

**Frontend**
- **React.js** : *For building a dynamic and responsive user interface.*

- **Tailwind CSS:** : *For styling the application with utility-first, responsive CSS classes.*

- **Material Tailwind:** : *A library of ready-made UI components and templates built with Tailwind CSS for faster and more consistent UI development.*

- **Axios** : *o make API calls to the backend.*

- **Chart.js** : *For displaying graphical data.*

**Backend**

- **Node.js & Express.js:** : * For handling API requests and business logic.*

- **MongoDB:** : *For storing transaction data securely.*

- **Mongoose:** : *o interact with the MongoDB database.*









1 change: 0 additions & 1 deletion client/public/vite.svg

This file was deleted.

3 changes: 3 additions & 0 deletions client/vercel.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"rewrites": [{ "source": "/(.*)", "destination": "/index.html" }]
}
21 changes: 21 additions & 0 deletions server/vercel.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"installCommand": "npm install --legacy-peer-deps",
"version": 2,
"builds": [
{
"src": "index.js",
"use": "@vercel/node"
},
{
"src": "src/**/*",
"use": "@vercel/static"
}
],
"routes": [
{ "src": "/(.*)", "dest": "/", "methods":["GET","POST", "PUT", "DELETE", "PATCH", "OPTIONS"],
"headers":{
"Access-Control-Allow-Origin": "*"
}
}
]
}

0 comments on commit 3e2cf6c

Please sign in to comment.