https://github.com/codewithdinesh/finwiz
https://github.com/codewithdinesh/finwiz
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/codewithdinesh/finwiz
- Owner: codewithdinesh
- Created: 2024-04-07T04:19:28.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-04-07T09:48:03.000Z (over 1 year ago)
- Last Synced: 2024-04-25T00:21:08.271Z (over 1 year ago)
- Language: JavaScript
- Size: 10.1 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Project Name: Finwiz
## Introduction
The Finwix project aims to provide users with personalized financial advice based on their financial parameters such as savings, assets, liabilities, and goals. The project utilizes AI algorithms to analyze user data and generate suggestions on investment strategies and financial improvements. This README provides an overview of the project, its functionalities, setup instructions, and usage guidelines.
## Features
- **User Authentication**: Allows users to register, login, and logout securely.
- **Financial Parameter Input**: Enables users to input their financial parameters such as savings, assets, liabilities, and goals.
- **AI Analysis**: Utilizes AI algorithms to analyze user data and provide personalized financial suggestions.
- **Investment Recommendations**: Offers suggestions on investment strategies based on user's financial situation and goals.
- **Financial Improvement Tips**: Provides tips and advice on how users can improve their financial health.
## Installation
To run the Financial Advisor project locally, follow these steps:
1. Clone the repository: `(https://github.com/codewithdinesh/finwiz)`
2. Navigate to the project directory: `cd finwiz`
3. Install dependencies: `npm install` (assuming npm is installed)
4. Set up environment variables:
- Create a `.env` file in the root directory.
- Define necessary environment variables such as database connection details, API keys, etc.
5. Set up the database:
- Run database migrations: `npm run migrate`
- (Optional) Seed the database with sample data: `npm run seed`
6. Start the server: `npm start`
7. Access the application via `http://localhost:3000` in your web browser.
## Usage
1. Register/Login:
- Create a new account or login using existing credentials.
2. Input Financial Parameters:
- Provide details such as savings, assets, liabilities, and financial goals.
3. Receive Suggestions:
- After submitting financial parameters, the AI algorithm will analyze the data and generate personalized suggestions.
4. View Recommendations:
- Explore investment recommendations and financial improvement tips provided by the system.
5. Logout:
- Securely logout from the system when done.
## Technologies Used
- **Frontend**: HTML, CSS, JavaScript (React)
- **Backend**: Node.js, Express.js
- **Database**: SQL (e.g., PostgreSQL)
- **Authentication**: JWT (JSON Web Tokens)
- **Others**: npm (package manager), dotenv (environment variables management), etc.
## Contributing
Contributions to the Financial Advisor project are welcome. If you find any bugs or have suggestions for improvements, please open an issue or submit a pull request.
## Acknowledgements
We would like to acknowledge the following resources and libraries used in this project:
- [Express.js](https://expressjs.com/)
- [React](https://reactjs.org/)
- [JWT](https://jwt.io/)