Skip to content

cnaples79/BudgetCraft3

Repository files navigation

BudgetCraft 3

BudgetCraft 3 is a comprehensive budgeting application that helps users manage their finances effectively. Built with modern technologies, it provides a seamless experience for tracking expenses, creating budgets, and analyzing financial data.

Features

  • Expense Tracking: Easily record and categorize expenses.
  • Budget Creation: Set up monthly or yearly budgets.
  • Financial Insights: Get detailed reports and insights into your spending habits.
  • Responsive Design: Works on desktop and mobile devices.
  • Modern Frameworks: Developed with performance and scalability in mind.

Technology Stack

Installation

Prerequisites

Steps

  1. Clone the repository:

    git clone <repository-url>
    cd BudgetCraft3-main
  2. Install dependencies:

    npm install
  3. Set up the environment variables:

    • Copy .env.example to .env and configure your environment variables.
  4. Start the development server:

    npm run dev
  5. Open the app in your browser or emulator:

    http://localhost:3000
    

Directory Structure

  • src: Contains the application source code.
  • public: Static files like images and fonts.
  • dist: Production build output.
  • tailwind.config.js: Tailwind CSS configuration.
  • nativescript.config.ts: NativeScript configuration for mobile compatibility.
  • vite.config.ts: Vite configuration for development and builds.

Scripts

  • npm run dev: Start the development server.
  • npm run build: Build the application for production.
  • npm run serve: Serve the production build locally.
  • npm run lint: Lint the codebase for errors.
  • npm run format: Format code using Prettier (if configured).

Contributing

Contributions are welcome! Follow these steps:

  1. Fork the repository.
  2. Create a feature branch.
  3. Commit your changes and push them to your fork.
  4. Open a pull request.

License

This project is licensed under the MIT License.

Support

If you encounter any issues, feel free to open an issue on the repository or contact the maintainer.

Developed with ❤️ from Charlotte.

About

Budgeting App Built With SQLite and TypeScript.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published