Budget Buddy

An awesome financial planner application based on mobile
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. License
5. Contact
6. Acknowledgments

About The Project

Welcome to the Budget Buddy Github repository! Here, you'll find the source code for our sleek and sophisticated financial planner application. Built with modern technologies and a focus on user experience, our application aims to provide users with an effortless financial planning experience.

back to top

Built With

Main technology used to built this application are listed below:

• Flutter
• Typescript
• Node.js
• Express.js
• MongoDB

back to top

Getting Started

To get started with this project locally, follow below steps:

Prerequisites

Make sure you have your device emulator, Flutter, Node.js, and package manager (either npm or yarn) installed

FYI: This project uses yarn as the server package manager, but you're free to use npm too.

Installation

Below steps will guide you through the local installation process of this application

1. Clone the repo

   git clone https://github.com/blesten/financial-planner.git
   

2. Complete the .env variable at /server directory Rename .env.example file at /config directory become .env, then fill the value for every key. Below is the guideline for filling the .env value:
   

   Key	What to Fill	Example Value
   PORT	Your server port	5000
   MONGO_URL	Your MongoDB connection URL	mongodb+srv://username:password@main.14znatw.mongodb.net/DBName?retryWrites=true&w=majority
   ACCESS_TOKEN_SECRET	Your JWT access token secret	NzeWG39JJNWASRKTeM85Ki77yZbdXZapvfIfepxz7d2WG
   TWILIO_ACCOUNT_SID	Your Twilio account SID	ACu893432jfoif
   TWILIO_AUTH_TOKEN	Your Twilio auth token	7cdjsfsf9df
   TWILIO_SERVICE_SID	Your Twilio service SID	VA8293303

3. Go to lib/utils/constants.dart at /client directory, and replace the serverURL port with the PORT defined previously at .env file. And for the domain itself, match it with the device that you're currently using. (For Android, http://10.0.2.2 can be used as the domain)
4. Open your terminal and cd to the /server directory, then run yarn install to install all the server dependencies
5. Open your terminal and cd to the /client directory, then run flutter pub get to install all the client dependencies
6. After installing the dependencies for both client and server, run yarn dev at the terminal that currently pointing at /server directory to start the server
7. To start the flutter application, run flutter run at the terminal that currently pointing at /client directory

back to top

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

back to top

License

Distributed under the MIT License. See LICENSE.txt for more information.

back to top

Contact

LinkedIn: Stanley Claudius

Project Link: https://github.com/blesten/financial-planner

back to top

Acknowledgments

Special thanks to:

• Othneildrew for providing an amazing README template.

back to top