Skip to content

Latest commit

 

History

History
91 lines (69 loc) · 2.88 KB

README.md

File metadata and controls

91 lines (69 loc) · 2.88 KB
Raw

Expense Tracker

Expense Tracker Banner

A web application to track your income and expenses effectively. Manage your financial data with features like transactions, budgeting, analytics, and alerts. The app also includes sections for Help, Settings, and a login page to keep your data secure.

🔗 Figma Design

You can view the Expense Tracker Figma design here.

🚀 Features

  • Dashboard: Get an overview of your financial status.
  • Transactions: Record and categorize income and expenses.
  • Budgets: Set and track your financial goals.
  • Analytics: Visualize your spending patterns and income trends.
  • Alerts: Receive notifications when approaching budget limits.
  • Help & Settings: Customize your experience and access support.
  • Login: Securely access your financial data.

🛠️ Tech Stack

This project uses the PERN Stack:

  • PostgreSQL: Database to store transactions, budgets, and user data.
  • Express.js: Backend server framework.
  • React.js: Frontend framework for a dynamic and responsive user interface.
  • Node.js: Server-side runtime.
  • Docker: Containerization for consistent development and deployment environments.

⚙️ Installation

Prerequisites

  • Node.js and npm
  • Docker (optional, for containerized deployment)

Steps

  1. Clone the repository:

    git clone https://github.com/yourusername/expense-tracker.git
cd expense-tracker

  2. Install dependencies:

    npm install

  3. Set up the Database: Configure your PostgreSQL database and update the connection settings in config.js.

  4. Start the development server:

    npm start

  5. Run in Docker (optional):

    docker-compose up

🤝 Contributing

Contributions are welcome! Follow these steps to contribute:

  1. Fork the repository
  2. Create a branch for your feature or fix: 
    git checkout -b feature-name
  3. Commit your changes: 
    git commit -m "Add feature name"
  4. Push to your branch: 
    git push origin feature-name
  5. Submit a pull request for review.

Please make sure to follow the Code of Conduct and check the Contributing Guidelines.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

📢 Tags

#ExpenseTracker #Income #Expenses #Budgeting #Analytics #PERNStack #FinanceApp #Docker #JavaScript #NodeJS #React

Feel free to reach out for questions or support in the project’s Issues section!

Created and maintained by Tristan Ehron Tumbaga