https://github.com/deepsalunkhee/hostel_bank_aws
https://github.com/deepsalunkhee/hostel_bank_aws
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/deepsalunkhee/hostel_bank_aws
- Owner: deepsalunkhee
- Created: 2024-02-18T10:52:40.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-02-18T11:35:23.000Z (over 2 years ago)
- Last Synced: 2025-05-17T11:37:09.850Z (about 1 year ago)
- Language: JavaScript
- Size: 149 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# Hostel Bank 💰💻
## Introduction 🚀
Hostel Bank is a web application designed to manage group finances and transactions among users. It allows users to create groups, add transactions, view transaction history, and receive notifications. If you have new feature ideas or want to improve existing features, you're always welcome to contribute!
## Features 🌟
- **User Authentication**: Users can sign up and sign in to their accounts securely.
- **Group Management**: Users can create groups and invite other users to join them.
- **Transaction Management**: Users can add transactions within their groups, specifying the amount, recipient, and notes for each transaction.
- **Notification System**: Users receive notifications for various group activities, such as new transactions and settling past dues.
- **History**: Users can view the transaction history.
- **Settings**: Users can manage their account settings, including password changes.
## Technologies Used 💻
- **Frontend**: React.js
- **Backend**: Node.js, Express.js
- **Database**: MongoDB
- **Authentication**: JSON Web Tokens (JWT)
- **Styling**: Tailwind CSS
- **Deployment**: Vercel
## Installation 🛠️
1. Clone the repository: `git clone https://github.com/deepsalunkhee/Hostel_Bank`
2. Navigate to the project directory: `cd HostelBank`
3. Install dependencies:
- Frontend: `cd client && npm install`
- Backend: `cd server && npm install`
4. Start the development servers:
- Frontend: `cd client && npm run dev`
- Backend: `npm server && npm run dev`
## Deployment 🚀
- Frontend: The frontend is automatically deployed to Vercel whenever changes are pushed to the `master` branch.
- Backend: Same for the backend.
## Contributing 🤝
- Contributions to Hostel Bank are welcome!
- Just open a new issue to discuss your idea with the maintainers.
- Ready to start building? Let's make Hostel Bank even better! 🌟🎉