Giter VIP home page Giter VIP logo

bank-crm-platform's Introduction

Bank CRM Platform

Overview

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.

Project Structure

The project is organized into two main directories:

  • backend/: Contains the NestJS backend application.
  • frontend/: Contains the Next.js frontend application.

Backend Setup (NestJS)

Prerequisites

  • Node.js (v20.12 or higher)
  • PostgreSQL

Installation

  1. Navigate to the Backend Directory:

    cd backend
  2. Install Dependencies:

    npm install
  3. Configure the Database:

    • Edit src/app.module.ts to set up your PostgreSQL database credentials.
  4. Run the Application:

    npm run start:dev

    The backend will be available at http://localhost:3000.

Database Setup

  1. 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;
  2. Ensure PostgreSQL is running on localhost:5432 or update src/app.module.ts to match your PostgreSQL instance settings.

Frontend Setup (Next.js)

Prerequisites

  • Node.js (v20.12 or higher)

Installation

  1. Navigate to the Frontend Directory:

    cd frontend
  2. Install Dependencies:

    npm install
  3. Configure Apollo Client:

    • Edit pages/_app.js to ensure the Apollo Client configuration matches the backend GraphQL endpoint.
  4. Run the Application:

    npm run dev

    The frontend will be available at http://localhost:3000.

Common Commands

Backend

  • Start the Backend Server:

    cd backend
    npm run start:dev
  • Run Tests:

    cd backend
    npm test

Frontend

  • Start the Development Server:

    cd frontend
    npm run dev
  • Build for Production:

    cd frontend
    npm run build
  • Run Tests:

    cd frontend
    npm test

CI/CD

The project uses GitHub Actions for continuous integration and deployment. Ensure to configure the workflow file (.github/workflows/ci.yml) according to your needs.

Contributing

  1. Fork the Repository:

    • Click on "Fork" at the top right of this repository's GitHub page.
  2. Clone Your Fork:

    git clone https://github.com/your-username/bank-crm-platform.git
  3. Create a Branch:

    git checkout -b feature/your-feature
  4. Commit Your Changes:

    git add .
    git commit -m "Add your commit message"
  5. Push to Your Fork:

    git push origin feature/your-feature
  6. Create a Pull Request:

    • Go to the original repository and create a pull request from your fork's branch.

License

This project is licensed under the MIT License - see the LICENSE file for details.

bank-crm-platform's People

Contributors

omerhabib62 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.