Skip to content

Commit

Permalink
docs: 리드미 수정
Browse files Browse the repository at this point in the history
우리의 프로젝트를 소개합니다!
  • Loading branch information
lallaheeee authored Nov 22, 2019
1 parent f15c277 commit fe6fa0e
Showing 1 changed file with 96 additions and 14 deletions.
110 changes: 96 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,113 @@
<h1 align="center">🥥 Cocode &nbsp🥥</h1>
<p>
<img alt="Version" src="https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000" />
<a href="https://github.com/YukJiSoo/umchan-server">
<img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" target="_blank" />
</a>
<p align="middle">
<img width="600" alt="코코드" src="https://i.imgur.com/VemoevT.png">
</p>

## Command
<br>
---

<!-- doc -->
<a href="https://github.com/connect-foundation/2019-04/wiki" target="_blank">
<img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
</a>
<!-- issue -->
<a href="https://github.com/connect-foundation/2019-02/issues">
<img alt="issue tracking" src="https://img.shields.io/github/issues/connect-foundation/2019-04"/>
</a>
<!-- pr -->
<a href="https://github.com/connect-foundation/2019-02/pulls">
<img alt="pr tracking" src="https://img.shields.io/github/issues-pr/connect-foundation/2019-04"/>
</a>
<!-- travis build status -->
<a href="https://travis-ci.org/connect-foundation/2019-04">
<img alt="pr tracking" src="https://travis-ci.org/connect-foundation/2019-04.svg?branch=master"/>
</a>

<br>
<br>

- clone을 받은 후 자신의 로컬환경에서 개별 service project에 대한 개발을 시작
- 개별 service project의 root directory에서 `npm install` 실행
## :house_with_garden: Home page
http://www.cocode.site

<br>

- 개발 container들을 실행시키는 docker-compose 명령어
## 📌 프로젝트 소개

> Cocode는 웹 통합개발환경 서비스를 제공하는 CodeSandbox를 clone하는 프로젝트입니다!
### 몇번의 클릭만으로 간편하고 빠르게 React 프로젝트를 생성해보세요!
실시간으로 브라우저 위에서 프로젝트 빌드 결과를 확인할 수 있습니다.
라이브 기능을 이용하면 다른 사용자와 같은 프로젝트를 동시에 편집할 수 있습니다.

<br>

## 📌 서비스 구성
```bash
🥥 cocode # 전체 service를 제공하는 client
🥥 coconut # client side build 기능을 수행하는 client
🥥 api-server # API server
🥥 live-server # 라이브 기능 제공 server
```
<br>

// 이미지를 다시 빌드하고 컨테이너 실행
## 📌 프로젝트 시작하기
> 각 디렉토리 별로 .env 파일을 작성하고 시작하셔야 됩니다.
> dev.env를 참고해주세요!
### 🐳 docker-compose로 한번에 시작
```bash
# 이미지를 다시 빌드하고 컨테이너 실행
docker-compose up --build

// 컨테이너 실행
# 컨테이너 실행
docker-compose up

// 백그라운드로 컨테이너 실행
# 백그라운드로 컨테이너 실행
docker-compose up -d

// 컨테이너 끄기
# 컨테이너 끄기
docker-compose down
```

### 🐕 cocode client
```
cd cocode
yarn
yarn start
```

### 🐈 api server
```
cd api-server
npm install
npm run dev
```

<br>
<br>

## 👨‍👩‍👧‍👦 멤버소개(순서대로)
<p align="middle">
<img width="500" alt="잘해잘해" src="https://i.imgur.com/1ZzsB4N.png">
</p>

<br>

### 👩‍ 김희라 [@lallaheeee](https://github.com/lallaheeee)
> 큼큼... 긁적긁적...
**스티브 희라**

### 👨‍ 김준표 [@BasilToast](https://github.com/BasilToast)
> 불-편하네요.
**불편한 양평사람**

### 👧‍ 우혜주 [@hzoou](https://github.com/hzoou)
> 대충? 인간에게 가장 해로운 벌레가 *대충* 이에요.
**우리 프로젝트의 비선실세!**

### 👦 육지수 [@yukjisoo](https://github.com/yukjisoo)
> 협업이 장난이에요?
**고추썰기대홰**

0 comments on commit fe6fa0e

Please sign in to comment.