superoctober1213 / bbchat

BBChat

Description

BBChat is a web-based social dating chat site. Like most communication software, BBChat has functions such as registering an account, adding friends, chatting with friends, and creating group chats. The characteristic function of BBChat is that you can enter a room name at any time to create a chat room, which is convenient for some users to communicate or transmit data in time. Another feature of BBChat is the discussion of hot topics. Users can find the latest hot topics on the website, and can choose hot topics of interest to discuss with other users.

Contributor

Frontend

• Yuxuan Zhang -- GithubID: superoctober1213
• Jinda Jia -- GithubID: jindajia

Backend

• Kexin Zhang -- GithubID: Cauchyxxx
• Junge Xu -- GithubID: Junge24

How to Run

• Clone the repository from the github: https://github.com/jindajia/BBChat.git
• Open terminal to run the backend server and then run the frontend

Backend

• open terminal
• cd BBChat/BackEnd-integrated
• go build
• go run server.go
• notes: if there are warnings or errors about can't find git root ...., please delete the .idea folder and reDo the go build and go run server.go steps.
• Database: we use mongoDB as the database for our project. When you running this project in local, make sure the database has been started up and connected properly.

Frontend

• open terminal
• cd BBChat/FrontEnd/React\ App
• npm install
• npm start

Link to Project Board for all Sprints

https://github.com/jindajia/BBChat/projects

Link to Sprint4 deliverables

https://github.com/jindajia/BBChat/blob/master/Sprint4/Sprint4.md

Link to API documentation

https://github.com/jindajia/BBChat/blob/master/Sprint4/APIDoc.md

Features we have done for the backend in this project

https://github.com/jindajia/BBChat/blob/master/Sprint4/BackEnd_Funcs.md

Demo video for functionality

functionality.mp4

Demo video for Cypress test

des.mp4

Demo video for Backend Unit Test

BackEnd_UnitTest.mp4