1tongp / crm-roomofrequirements

A CRM System built for the HSBC Insurance Department - Team of RoomOfRequirements

HSBC CRM System

A CRM system built for the HSBC insurance department!
Explore the project Confluence page »
View Prototype . View Trello Board

Table of Contents

1. CRM Requirement
2. The Crew
3. Built With
4. Getting Started
   • Prerequisites
   • Installation
5. Usage
6. License
7. Login Detail

CRM Requirement

Staffs of HSBC insurance department can get along with their customers to service and offer the tight products to them via the designed CRM system.

Our Goal

Our team will develop a CRM system for HSBC insurance department. The main goal of the system is to achieve easy and better connection with their customers.

The Crew

Name	Role	GitHub Page	Contact Email
Yitong Pei	Product manager	@1tongp	[email protected]
Jintong Liu	Backend lead	@crystal0161	[email protected]
Xinyi Ye	Frontend designer	@Xinyi-Y	[email protected]
Xinlin Li	Frontend designer	@Coco-byte	[email protected]
Xiaochen Hou	Frontend lead	@XiaochenHou	[email protected]

Built With

MERN

• MongoDB - document database
• Express(.js) - Node.js web framework
• React(.js) - a client-side JavaScript framework
• Node(.js) - the premier JavaScript web server

Getting Started

This is an instruction of how you may setting up your project locally.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Clone the repository

   git clone https://github.com/1tongp/CRM-RoomOfRequirements.git

2. Install NPM packages in main folder (backend)

   npm install

3. Install NPM packages in customer folder (frontend)

   cd customer 
   npm install 

Usage

• Run the back-end at http://localhost:8080

  npm run server

• Run the front-end at http://localhost:5000

  npm run customer

• Run express app (back-end and front-end run simultaneously) at http://localhost:3000

  npm run dev

License

Distributed under the MIT License.

Additional Documents

Confluence: https://room-of-requirement.atlassian.net/wiki/spaces/ROR/overview?homepageId=65716

Login Detail

Login Page:

• Email: [email protected]
• Password: 123456789a

Team Page:

• Name: You can use any name. (eg, Will)
• Room: You can use any room number (eg. 1), but you and your team member need to enter the same room to chat together.