Skip to content

Commit c2b3ac7

Browse files
committed
1차 릴리즈 README.md 수정
1 parent cf12484 commit c2b3ac7

1 file changed

Lines changed: 101 additions & 4 deletions

File tree

README.md

Lines changed: 101 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,98 @@
22

33
python 개발 환경부터 API, 게시판까지 만들기
44

5-
---
65

7-
### **What?**
6+
7+
## Develop Environments
8+
9+
***
10+
11+
- MacBook Pro (13-inch, 2017, Four Thunderbolt 3 Ports)
12+
- Python 3.7
13+
- vscode
14+
- Docker-Compose version 1.23.2, build 1110ad01
15+
16+
17+
18+
## Develop tools
19+
20+
***
21+
22+
- pipenv = pip + virtualenv
23+
- Flask-RESTPlus = Flask-RESTful + Swagger
24+
- MySQL docker container
25+
- Docker-compose
26+
27+
28+
29+
## Project Structure
30+
31+
***
32+
33+
```txt
34+
.
35+
├── README.md
36+
├── app
37+
│ ├── __init__.py
38+
│ ├── constans.py
39+
│ ├── api
40+
│ │ ├── __init__.py
41+
│ │ ├── auth_type.py
42+
│ │ └── database.py
43+
│ ├── posts
44+
│ │ ├── __init__.py
45+
│ │ ├── models.py
46+
│ │ └── views.py
47+
│ ├── users
48+
│ │ ├── __init__.py
49+
│ │ ├── models.py
50+
│ │ └── views.py
51+
│ └── tests
52+
├── confs
53+
│ └── database
54+
│ └── mysql
55+
│ └── .env
56+
├── Pipfile
57+
├── Pipfile.lock
58+
├── Makefile
59+
├── docker-compose.yml
60+
├── .gitignore
61+
└── .envrc
62+
```
63+
64+
65+
66+
## How to run
67+
68+
***
69+
70+
```bash
71+
> docker-compose up -d
72+
> pipenv shell
73+
> pipenv install --dev
74+
> make database
75+
> python manage.py run
76+
```
77+
78+
79+
80+
## Preview
81+
82+
***
83+
84+
![api_image](/images/api_image.png)
85+
86+
87+
88+
## Release
89+
90+
- 2019년 7월 25일 1차 릴리즈 v1.0
91+
92+
93+
94+
95+
96+
### What?
897

998
> 왜 해야 하는가
1099
@@ -13,6 +102,8 @@ python 개발 환경부터 API, 게시판까지 만들기
13102
3. 백 엔드, 프론트 엔드 까지 풀 스택을 목표로
14103
4. 프로페셔널한 개발자가 되기 위해서
15104

105+
***
106+
16107
### **개인적 의견**
17108

18109
안드로이드 클라이언트만 개발하다 보니 RESTful(?) 백 엔드(?) 뭐가 뭐인지 아무것도 이해할 수도 이해할 시간도 이해할 겨를도 없었다. 처음엔 말로만 백 엔드 개발자가 되어야지 그랬지만, 이제는 다르다. 서울에 올라온 만큼 내 롤 모델 개발자 형 밑에서 열심히 공부해 많은 것을 해 보고자 한다. 본인의 입으로 "나는 개발자다"라고 말하고 다니는 이상 모르고 넘어가면 안 될 부분이 상당히 많다고 생각한다. 이 프로젝트도 그러하다. 모르는 사람들은 절대로 모를 것이다. 백 엔드 프로그래머가 되기 위해서는 기본적으로 갖추어야 할 소양이라 생각한다!
@@ -34,12 +125,18 @@ python 개발 환경부터 API, 게시판까지 만들기
34125

35126
> 언제 할 것인가
36127
37-
2019년 7월 11일부터 시작했으며 게시판을 완성할 때까지 계속할 것이다.
128+
2019년 7월 11일부터 시작했으며 게시판 API를 완성할 때까지 계속할 것이다.
129+
130+
- 2019년 7월 25일 1차 릴리즈
38131

39132
---
40133

41134
### **Who?**
42135

43136
> 누가 하는가
44137
45-
알려주시는 형과 함께하지만, 당연히 혼자 머리를 싸매고 끙끙해야겠지 !
138+
내가 한다.
139+
140+
141+
142+
이제 시작해보도록 합시다!

0 commit comments

Comments
 (0)