Project12-A-Slack-Web

💥 프로젝트 소개

I'm slack은 팀 협업 도구인 Slack의 Web 버전을 개발하는 클론 프로젝트입니다. 팀이 공유하는 Workspace 내에서 Channel, DM을 통해 특정 멤버를 구성하고 실시간 채팅을 통해 자유롭게 소통할 수 있습니다.

👥 Team

J039_김서영	J062_김혜지	J088_박준호	J165_이한주

🖥 기술 스택

Architecture

DevOps

Socket flow

Demo video

🚦 How to start?

1. NPM

npm, node가 설치되어 있다면 이 방법으로 시작할 수 있습니다.

(1) Clone

git clone https://github.com/boostcamp-2020/Project12-A-Slack-Web.git

(2) Frontend Setting

cd client
npm install
# .env 파일 생성

.env

NODE_ENV=development
SERVER_DOMAIN_DEVELOP = http://localhost:3000
SERVER_DOMAIN_PRODUCTION = <배포 BE 서버 URL>
SOCKET_SERVER_DOMAIN_DEVELOP = http://localhost:4000
SOCKET_SERVER_DOMAIN_PRODUCTION = <배포 BE 서버 URL>

SERVER_DOMAIN_PRODUCTION와 SOCKET_SERVER_DOMAIN_PRODUCTION은 URL:3000, URL:4000와 같이 작성해주시면 됩니다.

(3) Backend Setting

cd ../server
npm install
# .env 파일 생성

.env

PORT = 3000
SOCKET_PORT = 4000
NODE_ENV = development
DB_HOST = <DB host>
DB_USER_NAME = <DB user name>
DB_PASSWORD = <DB password>
DB_PORT = <DB port>
DB_DATABASE = <DB database name>
JWT_SECRET_KEY = <JWT secret key>
BACK_DOMAIN_DEVELOP = http://localhost:3000
BACK_DOMAIN_PRODUCTION = <배포 BE 서버 URL>
FRONT_DOMAIN_DEVELOP = http://localhost:8000
FRONT_DOMAIN_DEVELOP_2 = http://127.0.0.1:8000
FRONT_DOMAIN_PRODUCTION = <배포 FE 서버 URL>
NCP_ACCESS_KEY= <Ncloud access key>
NCP_SECRET_KEY= <Ncloud secret key>
GOOGLE_CLIENT_ID= <Google client ID>
GOOGLE_CLIENT_SECRET = <Google client secret key>

(4) Backend 실행

npm start

(5) Frontend 실행

cd ../client
npm run dev

📄 Documents

• FE 기능 명세서
• Backlog
• DB Schema