README.md

재능 공유 플랫폼 Upgle

자신이 잘하는 분야를 화상 채팅을 이용하여 배우고 싶은 사람들과 실시간으로 인터랙션 하며 무료로 공유할 수 있는 플랫폼입니다.

Upgle 은 웹 사이트 환경에서 자신이 잘하는 분야를 공유하는 공유자와 배우고 싶은 분야를 배우는 사람들이 실시간으로 인터렉션 할 수 있게 도와주는 사이트입니다.

⭐️ 핵심 기능

🌈 재능공유자와 학습자가 만나기 위한 채널 기능

재능 공유자와 재능 참여자가 쉽게 만날 수 있는 채널을 만들어보세요!
누구나 채널을 만들 수 있고 누구나 채널에 가입할 수 있습니다.
채널을 통해 다른 사람들에게 자신만의 재능을 공유해주세요!😊

👥 효율적인 재능 공유를 위한 채팅 및 화상방 기능

재능 공유자가 편하게 재능을 공유하기 위해 채팅 및 화상방을 만들어주세요!
저희 서비스에서 채팅방과 화상방을 만들어서 좀더 효율적으로 재능을 공유하실 수 있습니다.👋🏻

📝 재능 공유가 끝나고 기록하는 아카이빙 기능

재능 공유가 끝나고 유익한 내용을 기록하고 싶다면?
재능 공유자가 채팅방에서 대화한 유익한 내용들을 직접 에디터를 통해 아카이빙으로 기록할 수 있습니다.
채널 가입자뿐만 아니라 다른 사람들에게도 유익한 내용을 공유해주세요!

서비스 결과물

https://upgle.hisfolio.com

Architecture

Dependencies

• express : 서버 프레임워크
• prisma : ORM
• passport : Auth
• cors : cors 셋팅
• dotenv : 환경변수
• express-validator : 요청값 검증
• nodemailer : 메일 발송
• multer : 파일 업로드
• babel : 트랜스파일러
• pm2 : 백그라운드 실행
• socket.io : 소켓 통신
• node-schedule : scheduler
• dayjs : 날짜 라이브러리
• bcrypt : 비밀번호 암호화
• cross-env : 환경변수 변경
• nodemon : 개발용 서버 재시작
• husky : git hook support
• eslint : 문법 분석
• prettier : 코드 포맷터

ERD

DB 설계 및 ER Diagram

🌟 Contribute

저희 서비스는 다른 사람들의 Contribute 를 원하고 있습니다. 👋🏻 아래는 설치 및 Contribute 가이드입니다.

installation

원활한 실행을 위해서는 node LTS 이상의 버전을, 저희 서비스에 Contribute 하기 위해서는 node v16.8.0을 준비해주시기 바랍니다

1. 업글 원격 저장소를 클론합니다.

$ git clone https://github.com/Jandy-SeoulTech/Jandy_Web_Back.git

2. 생성된 로컬 저장소로 이동 후 모듈을 설치합니다.

$ cd Jandy_Web_Back
$ npm install

3. 루트 디렉토리에 환경변수 파일을 셋팅합니다.

• 자세한 설명은 환경변수 파일 설명를 참고해주세요!

4. 서비스의 ORM과 DB를 연동시켜줍니다.

$ npm run db:generate
$ npm run dev-db:push

❗️ MySQL 서버가 실행되고 있어야 하고, 환경변수 파일의 셋팅이 정확해야 합니다. 5. 위 작업이 완료되었다면 실행을 해주세요!

$ npm run dev

Contribute

개발하시기 전 prettier가 에디터에 설정이 잘 돼있는지 확인해주세요!

기여 가이드라인을 참고해주세요.

👨‍👩‍👧‍👦 팀 멤버(Team Information)

Front-End Developer		Back-End Developer		Product Manager	Product Designer
김성태	황인서	조인혁	홍성웅	최민준	김연수

License

GPL-v3