The Bank CRM Platform is a comprehensive customer relationship management system designed for banks. It features a backend built with NestJS and a frontend developed using Next.js. The application provides tools for managing customer information, tracking interactions, and enhancing customer service.
The project is organized into two main directories:
backend/
: Contains the NestJS backend application.frontend/
: Contains the Next.js frontend application.
- Node.js (v20.12 or higher)
- PostgreSQL
-
Navigate to the Backend Directory:
cd backend
-
Install Dependencies:
npm install
-
Configure the Database:
- Edit
src/app.module.ts
to set up your PostgreSQL database credentials.
- Edit
-
Run the Application:
npm run start:dev
The backend will be available at
http://localhost:3000
.
-
Create a PostgreSQL Database:
CREATE DATABASE bank_crm; CREATE USER your_username WITH PASSWORD 'your_password'; GRANT ALL PRIVILEGES ON DATABASE bank_crm TO your_username;
-
Ensure PostgreSQL is running on
localhost:5432
or updatesrc/app.module.ts
to match your PostgreSQL instance settings.
- Node.js (v20.12 or higher)
-
Navigate to the Frontend Directory:
cd frontend
-
Install Dependencies:
npm install
-
Configure Apollo Client:
- Edit
pages/_app.js
to ensure the Apollo Client configuration matches the backend GraphQL endpoint.
- Edit
-
Run the Application:
npm run dev
The frontend will be available at
http://localhost:3000
.
-
Start the Backend Server:
cd backend npm run start:dev
-
Run Tests:
cd backend npm test
-
Start the Development Server:
cd frontend npm run dev
-
Build for Production:
cd frontend npm run build
-
Run Tests:
cd frontend npm test
The project uses GitHub Actions for continuous integration and deployment. Ensure to configure the workflow file (.github/workflows/ci.yml
) according to your needs.
-
Fork the Repository:
- Click on "Fork" at the top right of this repository's GitHub page.
-
Clone Your Fork:
git clone https://github.com/your-username/bank-crm-platform.git
-
Create a Branch:
git checkout -b feature/your-feature
-
Commit Your Changes:
git add . git commit -m "Add your commit message"
-
Push to Your Fork:
git push origin feature/your-feature
-
Create a Pull Request:
- Go to the original repository and create a pull request from your fork's branch.
This project is licensed under the MIT License - see the LICENSE file for details.