ShayanTheNerd / budgetly

A beautiful expense tracker for easily managing your financial accounts.

Budgetly

An intuitive expense tracker for easily managing your financial accounts.

Overview

The challenge

Users should be able to:

• Add or remove individual income or expense items containing a name followed by a value. Both adding and removing items will trigger smooth animations for all items in the list and also the calculated numbers.
• See the total of incomes and expenses, the balance, and the percentage of all expenses relative to the balance; all with animated numbers.
• Have all data saved to localstorage and displayed on page load using smooth animations.

Links

• Project homepage
• GitHub repository
• Issues
• Pull requests
• My other projects

My process

Built with:

• Semantic HTML
• Tailwind CSS - Styling
• Vue.js - JavaScript framework

I learned:

• How to set up a Vue.js 3 and Tailwind CSS project using Vite.
• How to use the basics of Vue.js, using Pinia for state management.
• How to use the Composition API in Vue.js and the VueUse library.

Development setup

1. First, you need to clone the project:

git clone https://github.com/ShayanTheNerd/budgetly.git

Alternatively, you can copy the source of the project directly to your local environment using Degit:

pnpm i -g degit

degit https://github.com/ShayanTheNerd/budgetly new-project-folder

2. Then, install required packages:

pnpm i

3. Finally, run the dev script to start the dev server and locally preview the project in development mode:

pnpm run dev

Deployment and production

Before deploying the project or creating a new pull request, run the following commands and make sure there are no errors:

pnpm run format

pnpm run build

Also, to ensure that everything is as expected, you can run the preview command to locally preview the project in production mode:

pnpm run preview

Style Guide

If you want to develop this project, please stick to these rules:

• Follow the current architecture, coding paradigm, and project folder structure.
• Follow the current character case principals for ids, classes, variables, file and folder names, etc.
• Code based on the current libraries, frameworks, and packages included in the project.
• For styling, utilize Tailwind's features as much as possible, but also make sure to use BEM methodology for naming custom CSS classes.
• Add Git commit messages considering Conventional Commits.

Contribution

Your contribution is always welcome, please follow these steps:

1. Fork the project.
2. Create your feature branch: git checkout -b feature/branch-name.
3. Make sure to follow instructions in the style guide section.
4. Stage all changes you made: git add -A.
5. Commit all staged changes with a descriptive commit message: git commit -m 'feat: add foo bar baz'.
6. Push everything to your feature branch: git push origin feature/branch-name.
7. Create a new Pull Request.

License

This project is licensed under MIT license. You're free to use it, but a link to this page and mentioning the author's name is mandatory. Created by Shayan Zamani.

back to top ⬆️