Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: readme 정리 #509

Merged
merged 6 commits into from
Mar 6, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 97 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,113 @@
# 모아밤
> 그룹 + 루틴이라는 시스템으로 사용자의 루틴을 실천할 수 있도록 도와주는 서비스

## 개요
![image](https://github.com/team-moabam/moabam-FE/assets/50488780/e7702870-af56-47fd-bb84-b816e959a0a9)

> 열심히 사는 새가 벌레를 먹는다. 🐦🦉
## 오프닝, 메인, 검색 페이지
![moabam1](https://github.com/team-moabam/moabam-FE/assets/50488780/3957e291-4e9e-4fde-936d-13f61852f86c)

당신은 규칙적인 삶을 살고 계신가요? 혹시 집과 회사만을 오가는 일상에 치여 자신과의 약속을 미루고 있지는 않나요?
쉽지만은 않은 자신과의 약속. 여러분과 같은 고민을 하고 있는 사람들과 함께 의지를 다져보면 어떨까요?
## 마이, 스킨, 상점 페이지
![moabam2](https://github.com/team-moabam/moabam-FE/assets/50488780/413c7ee6-6568-491d-ae3c-a6ee90be96c4)

## 기획 배경
## 방 생성 페이지
![moabam3](https://github.com/team-moabam/moabam-FE/assets/50488780/fcef86e1-e024-466e-86a9-e6394cccffbc)

오늘 날을 살아가는 사람들은 규칙적인 생활, 정리된 건강한 생활을 보내고 싶어합니다.
따라서 ‘루틴’ 이라는 용어도 급부상 하게 되었습니다. 하지만 마음과는 달리 바쁜 일상, 집과 회사만 오가는 패턴으로 인해 이를 실천하기를 어려워 합니다.
이런 문제를 해결하기 위해, 그룹 + 보상 이라는 시스템으로 루틴을 실천할 수 있도록 도와주는 서비스인 모아밤을 기획하게 되었습니다.
## 방 상세 페이지
![moabam4](https://github.com/team-moabam/moabam-FE/assets/50488780/2df250c2-635d-4436-bcbc-f537c3545ea1)


## 시연 영상
[![시연 영상](https://github.com/team-moabam/moabam-FE/assets/50488780/63dcbe33-e382-4427-91bb-112310ee98a2)](https://www.youtube.com/watch?v=_3enPDzkLns)

## 배포 주소

➡️ 스토리북 URL: https://moabam-storybook.netlify.app/
➡️ Production 배포 URL: https://www.moabam.com/
➡️ Staging 배포 URL: https://dev.moabam.com/

## 개발 서버 실행 방법

[➡️ 스토리북 URL](https://moabam-storybook.netlify.app/)
[➡️ 모아밤 Production 배포 URL](https://www.moabam.com/)
[➡️ 모아밤 Development 배포 URL](https://dev.moabam.com/)
**패키지 설치**

```
```sh
npm install
npm run dev
```

**개발 서버 실행**

로컬 환경에서 Mock API를 실행하기 위해서는 아래 커맨드로 msw를 활성화할 수 있습니다.

```sh
npm run dev:msw # msw를 활성화하여 개발 서버 실행
```


## 아키텍처
![image](https://github.com/team-moabam/moabam-FE/assets/50488780/6dfd5a1d-61b2-4ab8-b710-8807a9a66ccb)

## 주제 및 배경 소개

![image](https://github.com/team-moabam/moabam-FE/assets/50488780/6d5c8c55-bebf-42b2-a574-4c1b8988df89)
![image](https://github.com/team-moabam/moabam-FE/assets/50488780/6f0b21b6-fdad-4f3c-9b11-f97588e2d0b1)
![image](https://github.com/team-moabam/moabam-FE/assets/50488780/44ac4903-e9d3-4302-919a-ffb6469ff7dc)

## 팀원 소개

<table>
<tbody>
<tr>
<td>
<a href="https://github.com/chasj0326">
<img src="https://avatars.githubusercontent.com/chasj0326" width="100" height="100"/>
</a>
</td>
<td>
<a href="https://github.com/bbearcookie">
<img src="https://avatars.githubusercontent.com/bbearcookie" width="100" height="100"/>
</a>
</td>
<td>
<a href="https://github.com/nayeon-hub">
<img src="https://avatars.githubusercontent.com/nayeon-hub" width="100px" height="100px"/>
</a>
</td>
<td>
<a href="https://github.com/nsr1349">
<img src="https://avatars.githubusercontent.com/nsr1349" width="100px" height="100px"/>
</a>
</td>
</tr>
<tr>
<th>
<a href="https://github.com/chasj0326">차세진</a>
</th>
<th>
<a href="https://github.com/bbearcookie">이상훈</a>
</th>
<th>
<a href="https://github.com/nayeon-hub">박나연</a>
</th>
<th>
<a href="https://github.com/nsr1349">노성래</a>
</th>
</tr>
<tr>
<th>
FrontEnd
</th>
<th>
FrontEnd
</th>
<th>
FrontEnd
</th>
<th>
FrontEnd
</th>
</tr>
</tbody>
</table>

## 기술 스택

<table>
Expand Down