COMP30022 Group Project Team 4399

This repository is created for University of Melbourne COMP30022 Semester 2 2021

Personal Customer Relation Management (PCRM) project development.

---

Deployment Access Link and Working Branches

Server	Working Branch	Deployment
Back-End	https://bit.ly/3urzPG9	https://crm4399.herokuapp.com/
Front-End	https://bit.ly/3imk1zI	http://www.4399crm.com

Please view front end with screen size 375 x 875px (iPhoneX screen size)

---

For progress tracking & view notes, please accesss via notion.

📩 Contacts of tutor: t.bowes@unimelb.edu.au

📧 Contacts of client: aponiatowski@student.unimelb.edu.au

---

Table of Content

• COMP30022 Group Project Team 4399
• Team members
• Javascript Documentation
• Software Dependencies
• Built with
• Directories
• Quick Start Guide
• License

---

Team members

Name	Role	Contact
Bin Liang	Back End Leader	blliang@student.unimelb.edu.au
Hongji Huang	Communication Leader	hohuang@student.unimelb.edu.au
Sunchuangyu Huang	Scrum Master	sunchuangyuh@student.unimelb.edu
Wei Zhao	Front End Leader	weizhao1@student.unimelb.edu.au
Yixiao Tian	Communication leader	yixiaot@student.unimelb.edu.au

Javascript API Documentation

• Contact Controller
• Profile Controller
• Record Controller
• User Controller
• Authentication Controller

Software Dependencies

For more information, please check package.json.

For quick installation:

npm install # install all dependencies or
npm install --dependencies # install required dependencies only

Built With

Our project was built with the following technologies:

• Node.js
• React.js
• Express.js
• CSS
• HTML
• MongoDB

Directories

• __test__: store jest API backend testing functions
• config: store application session authentication functions
• controller: store controllers for each accessible routes
• models: store database connection script and database schemas
• public: store html fragments
• routes: store server accessible routes
• views: handlebar views (none-use)
• out: store javascript doc

Quick Start Guide

Before start development or testing, please make sure all required dependencies have been installed.

For convenience purpose, please use nodemon instead of node.

nodemon app.js

TESTING

For backend function testing, using POSTMAN to test the backend routes and relevant API functions.

Check POSTMAN testing instruction here

Download POSTMAN testing JSON

For built-in JEST function testing, use npm test.

License

See more information, click here.