BudgetRoyale is a gamified personal finance tracking web application designed specifically for university students. The app allows users to manage their expenses, income, and budgets efficiently while rewarding them with points for staying within budget and categorizing expenses. Users can unlock advanced features like personalized financial advice, goal tracking, and custom notifications by accumulating points.
- Expense and Income Tracking: Track daily, weekly, monthly, and annual expenses and income.
- Budget Management: Set and manage budgets for different periods.
- Recurring Transactions: Add recurring transactions with different frequencies.
- Visualizations: Visualize expense and income trends with charts.
- AI-Based Categorization: Categorize expenses using AI-based categorization.
- Points and Rewards: Earn points for staying within budget and categorizing expenses, which can unlock premium features such as personalized advice and goal tracking.
- Dark Mode and Light Mode: Toggle between dark mode and light mode themes.
- Real-Time Updates: Real-time updates with Firestore integration.
- React: For building the user interface.
- Firebase: For backend services including Firestore and Authentication.
- Chart.js: For data visualization.
- OpenAI API: For AI-based expense categorization.
Ensure you have the following installed on your machine:
- Node.js
- npm (Node Package Manager)
- Firebase account and project
- OpenAI API key
This project was bootstrapped with Create React App.
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.
The page will reload when you make changes.
You may also see any lint errors in the console.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
Note: this is a one-way operation. Once you eject, you can't go back!
If you aren't satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
You don't have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify