https://github.com/codestates-seb/seb41_main_024
https://github.com/codestates-seb/seb41_main_024
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/codestates-seb/seb41_main_024
- Owner: codestates-seb
- Created: 2023-01-03T00:48:25.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-28T03:13:37.000Z (almost 3 years ago)
- Last Synced: 2025-04-13T01:56:06.562Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://ngether.xyz/
- Size: 175 MB
- Stars: 7
- Watchers: 2
- Forks: 4
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Ngether(엔게더) - 실시간 위치기반 공동구매 플랫폼
노션 링크
서비스 링크
## Ngether 로컬에서 시작하기
---
Client
$\huge\textnormal{\color{#5ad7b7}yarn\ install}$
개발에 필요한 패키지들을 설치합니다.
$\huge\textnormal{\color{#5ad7b7}yarn\ dev}$
개발 모드로 앱을 실행합니다.
브라우저에서 https://localhost:3443으로 실행됩니다.
$\huge\textnormal{\color{#5ad7b7}yarn\ build}$
작업 완료 후 배포를 위한 build폴더가 생성됩니다.
https 서버 시작하기
http에서는 지도 서비스를 지원하지 않습니다. https 환경에서 앱을 시작해주시기 바랍니다
mac에서 설치하기
$\huge\textnormal{\color{#5ad7b7}brew\ install\ mkcert}$
Linux에서 설치하기
$\huge\textnormal{\color{#5ad7b7}sudo\ apt\ install\ libnss3-tools}$
공통
mkcert key.pem cert.pem 입력 후 파일명 key.pem과 cert.pem으로 변경
Server
aws와 github actions를 사용하여 서버 배포하기
- 레포지토리에 변화가 생기면 Github Actions 작동
- 프로젝트 빌드 결과물(.jar)을 S3로 전송 및 저장
- Amazon CodeDeploy에 배포 명령
- S3에서 Amazon CodeDeploy에 프로젝트 빌드 결과물(.jar) 전달
- EC2 배포 및 실행
## 나누조 팀소개
---
|김형진|김은수|박경현|송현우|
|:--:|:--:|:--:|:--:|
|[
](https://raw.githubusercontent.com/codestates-seb/seb41_main_024/readme/readmeImage/%EA%B9%80%ED%98%95%EC%A7%84.png)|[
](https://raw.githubusercontent.com/codestates-seb/seb41_main_024/readme/readmeImage/%EA%B9%80%EC%9D%80%EC%88%98.png)|[
](https://raw.githubusercontent.com/codestates-seb/seb41_main_024/readme/readmeImage/%EB%B0%95%EA%B2%BD%ED%98%84.png)|[
](https://raw.githubusercontent.com/codestates-seb/seb41_main_024/readme/readmeImage/%EC%86%A1%ED%98%84%EC%9A%B0.png)|
|FE(팀장)|FE|FE|FE|
|[koreadinosaur](https://github.com/koreadinosaur)|[noah-eunsoo](https://github.com/noah-eunsoo)|[Pikadev1771](https://github.com/Pikadev1771)|[SHWsgithub](https://github.com/SHWsgithub)|
|김연주|박지윤|최지현|
|:--:|:--:|:--:|
|[
](https://raw.githubusercontent.com/codestates-seb/seb41_main_024/readme/readmeImage/%EA%B9%80%EC%97%B0%EC%A3%BC.png)|[
](https://raw.githubusercontent.com/codestates-seb/seb41_main_024/readme/readmeImage/%EB%B0%95%EC%A7%80%EC%9C%A4.png)|[
](https://raw.githubusercontent.com/codestates-seb/seb41_main_024/readme/readmeImage/%EC%B5%9C%EC%A7%80%ED%98%84.png)|
|BE|BE|BE|
|[yeonzzoo](https://github.com/yeonzzoo)|[parkjiyun98](https://github.com/parkjiyun98)|[Aru-slave](https://github.com/Aru-slave)|
## 아키텍처
---
## ERD
---
## Ngether 사용 예시
---
회원가입 및 로그인, 마이페이지
메인페이지
회원가입
로그인
마이페이지
게시물 등록, 검색, 수정
게시물 등록
검색
수정
삭제
주소록 등록, 나의 쉐어링, 찜
주소록 등록
나의 쉐어링
1:1 문의 등록
채팅리스트, 채팅방
채팅리스트, 채팅방
유저 강퇴 (방장일 시)
강퇴당한 유저
강퇴당한 유저 해당 게시물 입장 시도시
관리자 페이지
유저 신고 및 문의 처리
## git & github guide
---
branch
-
strategy
- main브랜치에서 dev브랜치를 생성합니다. dev브랜치에서 feat브랜치를 생성 후 작업합니다.
- 작업이 완료된 feat브랜치들은 dev브랜치에만 merge할 수 있습니다.
- 배포 전 개발 완료된 dev브랜치를 main브랜치에 merge후 main브랜치를 배포합니다.
-
branch types
- main : 배포 브랜치
- dev : 개발 브랜치
- feat/branchname : 기능 브랜치
- hotfix : 오류 또는 긴급 수정 브랜치
-
feat브랜치 name style
-
basic : 기능별로 브랜치를 생성하고, 1개의 브랜치는 1명의 사용자가 담당합니다.
feat/개발영역/기능명
feat/front/login
feat/back/login
-
sub : 예외상황으로 1개의 브랜치에서 여러명이 작업할 경우 sub브랜치 생성 후 작업합니다.
feat/개발영역/기능명_sub_세부기능
feat/front/login_sub_sns
feat/back/login_sub_sns
-
commit
-
structure
타입 - #이슈번호 : 제목
(공백줄)
상세 설명
-
type
- feat: A new feature
- fix: A bug fix
- docs: Changes to documentation
- style: Formatting, missing semi colons, etc; no code change
- refactor: Refactoring production code
- test: Adding tests, refactoring test; no production code change
- chore: Updating build tasks, package manager configs, etc; no production code change
-
example
feat - #1 : 로그인 html,css 완료
공통 인풋 텍스트, 버튼 컴포넌트 적용
merge
- github pull request를 사용해 merge합니다.
- front개발은 최소 front 1명을 리뷰어로, back개발은 최소 back 1명을 리뷰어로 pull request 합니다.
- front, back 같이 진행하는 개발은 최소 front,back 각 1명을 리뷰어로 pull request 합니다.