Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/7irelo/loretta-bank-web
Full Stack Online Banking Web Application (Node, Express, React, and PostgreSQL)
https://github.com/7irelo/loretta-bank-web
express node postgresql react
Last synced: about 2 months ago
JSON representation
Full Stack Online Banking Web Application (Node, Express, React, and PostgreSQL)
- Host: GitHub
- URL: https://github.com/7irelo/loretta-bank-web
- Owner: 7irelo
- License: mit
- Created: 2024-05-22T07:08:07.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-11-09T14:29:17.000Z (2 months ago)
- Last Synced: 2024-11-09T15:28:02.238Z (2 months ago)
- Topics: express, node, postgresql, react
- Language: JavaScript
- Homepage:
- Size: 8.8 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Loretta Bank
Welcome to Loretta Bank, an online banking application built with Node.js, Express, PostgreSQL, and React. Loretta Bank offers a secure, user-friendly platform for managing your banking needs online.
## Table of Contents
- [Features](#features)
- [Tech Stack](#tech-stack)
- [Installation](#installation)
- [Usage](#usage)
- [API Endpoints](#api-endpoints)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
- [Folder Structure](#folder-structure)
## Features
- User Authentication (Sign Up, Log In, Log Out)
- Account Management (Create, View, Update, Delete Accounts)
- Fund Transfers (Internal and External)
- Transaction History
- Balance Inquiries
- Responsive Design
## Tech Stack
- **Backend**: Node.js, Express
- **Database**: PostgreSQL
- **Frontend**: React
- **Authentication**: JWT (JSON Web Tokens)
- **Styling**: CSS, Bootstrap
## Installation
### Prerequisites
- Docker and Docker Compose installed
- Git installed
### Docker Setup
1. Clone the repository:
```bash
git clone https://github.com/7irelo/loretta-bank-web.git
cd loretta-bank-web
```
2. Build and start the containers:
```bash
docker-compose up --build
```
### Environment Variables
Make sure to update your environment variables as needed. Here are the default ones used in the Docker setup:
- Backend `.env`:
```env
PORT=3001
DATABASE_URL=postgres://postgres:password@db:5432/loretta_bank
JWT_SECRET=your_jwt_secret
```
- Frontend `.env`:
```env
REACT_APP_API_URL=http://localhost:5173
```
## Usage
- Open your web browser and navigate to `http://localhost:5173`
- Sign up for a new account or log in with your existing credentials
- Manage your accounts, transfer funds, and view transaction history
## API Endpoints
### Authentication
- `POST /api/auth/register` - Register a new user
- `POST /api/auth/login` - Log in a user
- `GET /api/auth/me` - Fetch logged in user
- `PUT /api/auth/logout` - Update logged in user
- `PATCH /api/auth/logout` - Update logged in user
### Accounts
- `GET /api/accounts` - Get all accounts for the authenticated user
- `POST /api/accounts` - Create a new account
- `GET /api/accounts/:id` - Get a specific account
- `PUT /api/accounts/:id` - Update a specific account
- `DELETE /api/accounts/:id` - Delete a specific account
### Transactions
- `GET /api/transactions` - Get all transactions for the specific account
- `POST /api/transactions` - Create a new transaction
- `GET /api/transactions/:id` - Get a specific transaction
- `PUT /api/transactions/:id` - Update a specific transaction
- `DELETE /api/transactions/:id` - Delete a specific transaction
### Cards
- `GET /api/cards` - Get all cards for the specific account
- `POST /api/cards` - Create a new card
- `GET /api/cards/:id` - Get a specific card
- `PUT /api/cards/:id` - Update a specific card
- `DELETE /api/cards/:id` - Delete a specific card
### Loans
- `GET /api/loans` - Get all loans for the specific account
- `POST /api/loans` - Create a new loan
- `GET /api/loans/:id` - Get a specific loan
- `PUT /api/loans/:id` - Update a specific loan
- `DELETE /api/loans/:id` - Delete a specific loan
### Customer Support Ticket
- `GET /api/support` - Get all support tickets for the specific user
- `POST /api/support` - Create a new support ticket
- `GET /api/support/:id` - Get a specific support ticket
- `PUT /api/support/:id` - Update a specific support ticket
- `DELETE /api/support/:id` - Delete a specific support ticket
## Contributing
Contributions are welcome! Please follow these steps to contribute:
1. Fork the repository
2. Create a new branch (`git checkout -b feature/your-feature-name`)
3. Commit your changes (`git commit -m 'Add some feature'`)
4. Push to the branch (`git push origin feature/your-feature-name`)
5. Open a pull request
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Contact
For any inquiries or issues, please contact us at [[email protected]](mailto:[email protected]).
## Folder Structure
```
loretta-bank-web/
├── client/ # React frontend
│ ├── public/
│ ├── src/
│ ├── .env
│ ├── Dockerfile
│ └── package.json
├── server/ # Node.js backend
│ ├── config/ # Database and app configuration
│ ├── controllers/ # Route controllers
│ ├── middlewares/ # Middleware functions
│ ├── models/ # Database models
│ ├── routes/ # API routes
│ ├── services/ # Business logic
│ ├── utils/ # Utility functions
│ ├── .env
│ ├── Dockerfile
│ └── package.json
├── docker-compose.yml # Docker Compose configuration
└── README.md
```