Welcome to FinHub!
A powerful and user-friendly finance app built with the MERN stack, inspired by Fincart. This project aims to make financial planning accessible and insightful for everyone, offering personalized insights and tracking features for better financial health. Join us to help build and improve FinHub, where contributions of all skill levels are welcomed!
We're launching this project during Hacktoberfest, making it an ideal opportunity for you to gain hands-on experience, learn from fellow developers, and make impactful contributions. Whether you're an experienced developer or just starting out, there's a task for you. From adding new features and enhancing UI/UX to fixing bugs and writing documentation, every contribution counts!
- Financial Dashboard: Monitor savings, investments, and goals in one place
- Smart Suggestions: Personalized recommendations based on user data
- Goal Tracking: Set and track short- and long-term financial goals
- Modern UI: Intuitive, responsive design for a seamless experience
- Frontend: Next.js , React.js, Redux,
- Backend: Node.js, Express.js, MongoDB
- Authentication: JWT-based authentication for secure access
Take referance of https://www.fincart.com/
- Feature Development: Add new features or improve existing ones (color theme use as green)
- UI/UX Enhancements: Help us create a user-friendly interface
- Bug Fixes: Find and fix issues to make the app more reliable
- Documentation: Improve our docs for better clarity and accessibility
Join us in making FinHub a valuable tool for anyone looking to manage their finances better. Let's build something amazing together!
Prerequisites:
- Node.js (version 14.x or higher)
- pnpm or yarn
- MongoDB (local or Atlas)
-
Fork and Clone the project
git clone https://github.com/<YourAccount>/finhub-An-finance-app-using-mern-stack-nextjs.git
-
Open Project in Local System and Navigate to Project Directory
cd finhub-An-finance-app-using-mern-stack-nextjs -
Install Dependencies
-
For pnpm
pnpm install
-
For yarn
yarn install
-
Rename .env.local sample to .env and setup
MONGODB_URI=your_mongodb_connection_string JWT_SECRET=your_jwt_secret
-
Run the Project
-
For pnpm
pnpm dev
-
For yarn
yarn dev
We believe in the power of collaboration, and we welcome everyone to contribute to FinHub to help it grow into a valuable tool for personal finance management. Below is a guide on how to make contributions to this open-source project.
-
Fork the Repository:
Start by forking the repository to your own GitHub account. This will create a copy of the project that you can modify.git clone https://github.com/<YourAccount>/finhub-An-finance-app-using-mern-stack-nextjs.git
-
Create a new Branch: To keep things organized, create a new branch for your changes.
Naming convention: feature/ or bugfix/.
git checkout -b feature/<feature-name>-
Make Changes or solve issues Work on the new feature, bug fix, or documentation update. Be sure to follow coding standards and write clear, maintainable code
-
Test Your Changes Make sure everything works as expected by running the project locally and testing the new features.
-
Commit and Push Your Code Write clear commit messages explaining what your changes are. After that, push your branch to your forked repository.
git add .
git commit -m "Added <description of the changes>"
git push origin feature/<feature-name>
- Submit a Pull Request Go to the fork repository of this Project on Your GitHub and Compare changes then, submit a pull request.
Describe the changes in detail and link any related issues by using ' # ' Ensure your pull request description is clear and includes screenshots if necessary