Expense Tracker CLI is a Node.js application designed to help you manage your personal finances directly from the command line. This tool allows users to track expenses, categorize them, and maintain a clear overview of their financial situation without the need for a graphical user interface. The application is fully modular and scalable, enabling easy adaptation and expansion to meet your needs.
- TypeScript: Ensures type safety and improves code maintainability.
- Joi: Used for validating expense data.
- Node.js: The runtime environment for executing the CLI.
- Winston: For logging purposes.
- UUID: For generating unique IDs.
This project adheres to the following practices and methodologies:
- SOLID Principles: Ensuring clean and maintainable code.
- Modular Design: Breaking down the application into smaller, independent modules for easier maintenance and scalability.
- Pattern: MVC.
- Documentation: The code is thoroughly documented to facilitate understanding and expansion.
- index.ts: The main entry point of the application.
- router: Handles routing for command execution.
- src/: Contains the project's source code.
- commands/: Contains command definitions.
- controllers/: Manages the application logic.
- repositories/: Handles data persistence and retrieval.
- services/: Contains business logic.
- models/: Defines models for expenses and DTOs.
- config/: Configuration files, including logging setup.
- errors/: Custom error handlers for managing exceptions.
- tests/: Contains unit tests written in Jest.
- dist/: Contains the compiled JavaScript code.
- validators/: Contains validation logic.
To install and run this application locally, follow these steps:
# Clone the repository
git clone https://github.com/roadmap-mini-projects/expense-tracker-cli.git
# Navigate to the project directory
cd expense-tracker-cli
# Install dependencies
npm install
# Build the project
npm run build
# Run the application
node dist/index.js [command]To use the expense-cli command from any directory, you can add expense-cli.bat to the PATH.
Run expense-cli followed by a command to interact with the application:
# Add a new expense
expense-cli add
# Update an existing expense
expense-cli update
# Delete an expense by name
expense-cli delete
# List all expenses or filter by status
expense-cli list
# Update the category of an expense
expense-cli update-category
# Update the status of an expense
expense-cli update-status
# Delete all expenses
expense-cli delete-allFor more details on the commands, you can run:
expense-cli --helpContributions are welcome. You can open an issue or submit a pull request on the GitHub repository.
If you have any questions or suggestions, feel free to contact me through GitHub or LinkedIn.