Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/sparcs-kaist/otlplus

Online Timeplanner with Lectures Plus @ KAIST http://otl.kaist.ac.kr
https://github.com/sparcs-kaist/otlplus

django mysql python

Last synced: 24 days ago
JSON representation

Online Timeplanner with Lectures Plus @ KAIST http://otl.kaist.ac.kr

Lists

README 

        
# OTL PLUS



Online Timeplanner with Lectures Plus @ KAIST 



## 채널



* 구글 드라이브 (archived): https://drive.google.com/folderview?id=0By2h7PuCHN8ZUmJ6cjQtQlJUNDA&usp=sharing

  * 팀원들에 한해 doc.google.com에 otlplus 공용계정: [email protected]으로 로그인해서 열람하실 수도 있습니다.

* Notion: https://www.notion.so/sparcs/OTL-Plus-69724cd9c1434d64ac379e8f6590c885

* Slack: #otl, #otl-plus, #otl-notify

* Contact: [email protected]



## 디자인



* ~~Invision 프로토타입 (deprecated): https://invis.io/7FATPIZHK~~

* ~~구글 드라이브 (deprecated): https://drive.google.com/drive/folders/0B7OgXXGKTmCOamtPS0NRNzFXdHc?usp=sharing~~

* XD 프로토타입: https://xd.adobe.com/view/abb6898c-eff7-42c1-b383-b9518d8c68af-fee5/?fullscreen

* XD 개발 사양: https://xd.adobe.com/view/6a2a4884-ac98-4c59-85ea-950e2f3012d6-3f79/



## 개발 환경 설정



### 0. 준비요건



* Docker가 설치되어 있어야 합니다.

* Windows의 경우 wsl shell에서 명령어들을 실행해야 합니다.

* Frontend는 3000, Backend는 58000, DB는 53306 포트를 사용합니다. 따라서 이 포트들은 사용되지 않은 상태여야 합니다.



### 1. Git clone하기



```bash

git clone https://github.com/sparcs-kaist/otlplus

cd otlplus

```



### 2. Secret 설정하기



**⚠️ 초기 설정에만 다음의 Secret 설정들이 필요합니다.**



#### Django secret 설정하기



`DJANGO_SECRET_KEY`는 임의의 문자열을 사용해도 무관합니다.



```bash

mkdir keys && touch ./keys/sso_secret && echo "DJANGO_SECRET_KEY" > ./keys/django_secret

```



#### SPARCS SSO secret 설정하기



1. SPARCS 계정으로 [sparcssso.kaist.ac.kr](http://sparcssso.kaist.ac.kr) 로그인한 후 상단의 Dev Center로 접속

2. Test Services의 register를 누릅니다.

3. 다음의 정보를 입력하여 Test Service를 생성합니다.



> Alias: (Any name)  

> Main URL:   

> Login Callback URL:   

> Unregister URL:   

> Cooltime: 0



4. Dev Center 홈으로 돌아가 생성된 Test Service에 위치한 Modify 버튼을 누릅니다.

5. otlplus 폴더에 ./settings_local.py를 생성한 후 4에서 들어간 페이지에 적힌 Name과 Secret Key를 참고하여 다음의 형식으로 작성합니다.



```python

SSO_IS_BETA = False

SSO_CLIENT_ID = "test0000000000000000" # SSO의 'Name' (또는 'Client ID') 필드

SSO_SECRET_KEY = "00000000000000000000" # SSO의 'Secret Key' 필드

```



### 3. Backend 시작하기



Backend를 시작하고 싶다면 otlplus 폴더에서 다음 명령어를 실행합니다.



```bash

OTLPLUS_DB_PASSWORD=p@ssw0rd docker compose up

```



> WSL에서 docker 명령어 없음으로 뜬다면,  

> Docker 실행 후 settings > resources >wsl integration >enable integration with ~ 를 켜줍니다.



#### [초기 필수] Migrate하기



**⚠️ 초기 설정이거나 DB 구조가 변경된 경우에만 다음이 필요합니다.**



1. `docker compose up`을 실행한 방금 터미널을 그대로 둡니다.

2. 새로운 터미널을 켭니다.

3. 다음을 한 줄씩 실행합니다.



```bash

docker exec -it otlplus-back /bin/bash

python manage.py migrate

exit

```



#### [선택] DB Dump 파일 적용하기



**⚠️ 기존 DB Dump 파일을 적용하고 싶은 경우에만 다음이 필요합니다.**



1. 담당자에게 요청해서 dump.sql 파일을 다운로드 받습니다.

2. otlplus 폴더 기준 ./volumes/dump/dump.sql 경로로 dump.sql을 옮깁니다.

3. 다음을 한 줄씩 실행합니다.



```bash

docker exec -it otlplus-db /bin/bash

mysql -uroot -p'p@ssw0rd' -Dotlplus < /dump/dump.sql

exit

```



### 4.Frontend 시작하기



프론트엔드 코드는 otlplus-web 레포에 있습니다.

아래 명령어와 같이 원하는 위치에 해당 레포를 클론한 후 실행해 주세요.



```bash

cd ..

git clone https://github.com/sparcs-kaist/otlplus-web

cd otlplus-web



npm i

npm start

```



### 5. DB 접속하기



DB 접속을 원하는 경우 다음의 정보를 사용하세요.



> host: localhost  

> port: 53306  

> user: root  

> password: p@ssw0rd  

> name: otlplus



### 6. 정리하기



만약 실행했던 개발 환경을 정리하고 싶다면 아래 명령어를 입력해 주세요.



```sh

docker compose down

rm -rf ./volumes/db

```



### TroubleShooting



#### (Windows) git clone시 유의사항



local window에 clone 후, wsl shell로 실행하면 오류가 발생합니다.

(local window에 clone하면 `user@desktop:mnt/` 에서 실행됩니다.)



wsl2 shell을 실행한 뒤, wsl2 shell 상에서 git clone을 해야 합니다.



#### (Windows) wsl 상에서 docker compose up 시 유의사항



docker 명령어 없다는 콘솔창이 뜨면 아래 명령어를 입력하여 wsl version이 1인 distro를 확인 한 뒤, wsl version 2로 바꾸어줍니다.



```cmd

wsl.exe -l -v 

wsl.exe --set-version (distro name) 2 

```



## 개발 환경 설정 (Deprecated)



2023.5.5. 까지 사용했던 Docker Compose 없는 개발 환경입니다.



### Django 환경 설정



Working directory: `PROJECT_ROOT`

@sboh1214: [email protected] 과 [email protected] 에서 정상작동 확인하였습니다. (2023-03-10)



```shell

# 가상환경 설정

$ python3 -m venv env # Python 버전 3.6 이상 권장

$ source env/bin/activate



# 패키지 설치

$ pip install -r requirements.txt # unixodbc, [email protected] 등을 먼저 설치해야 할 수 있음 (apt, brew 등으로 설치)



# Secret key 설정

$ mkdir keys

$ vi keys/django_secret # Random string 입력, Django SECRET_KEY 명세 참고

$ touch keys/sso_secret



# DB migrate

$ python manage.py migrate

```



만약 파이썬 패키지 설치가 정상적으로 이루어지지 않는다면 아래 명령어를 입력해주세요.



```shell

pip install -r requirements.txt --use-feature=2020-resolver

```



### 개발용 DB 설정 (Optional)



dump 데이터는 PM에게 요청하세요.  

Working directory: `PROJECT_ROOT`



```shell

# Dump 파일 불러오기

$ python manage.py load-dev-data dumps/otldump_DATE_info.json

```



### SPARCS SSO 설정



SSO 설정 방법은 변경될 수 있습니다. SSO 공식 설정 방법을 참고하세요.  

URL: `sparcssso.kaist.ac.kr > Dev Center > Test Services > Register`

> Alias: (Any name)  

> Main URL: http://localhost:8000  

> Login Callback URL: http://localhost:8000/session/login/callback  

> Unregister URL: http://localhost:8000/session/unregister  

> Cooltime: 0  



Working directory: `PROJECT_ROOT`



```shell

$ vi settings_local.py

```



File: `PROJECT_ROOT/settings_local.py`



```python

# ...



SSO_IS_BETA = False

SSO_CLIENT_ID = "test0000000000000000" # SSO의 'Name' (또는 'Client ID') 필드

SSO_SECRET_KEY = "00000000000000000000" # SSO의 'Secret Key' 필드

```



### React 환경 설정



Working directory: `PROJECT_ROOT/react`



```shell

# 패키지 설치

$ npm install



# 개발 서버 실행

$ npm start



# 프로젝트 빌드

$ npm run build

```



### 서버 실행



Working directory: `PROJECT_ROOT`



```shell

$ python manage.py runserver 0.0.0.0:8000

```



이때 반드시 브라우저에서 `http://localhost:8000`으로 접속해야 합니다.



### 에디터 설정 (Optional, but highly recommended)



VSCode(Visual Studio Code) 및 아래 설정을 권장합니다.



* Extension 설치

    * ESLint (https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)

* 설정

    * Command Palatte (단축키: F1) > Python: Select Linter > pylint



### 설정 중 오류



#### DB migrate 시 "... SQLite < 3.26 ..." 오류가 발생한다면



아래 명령어로 python에 적용된 sqlite3 버전 확인



```shell

$ python -c "import sqlite3;print(sqlite3.sqlite_version)"

```



3.26.0 이하라면 높은 버전의 python으로 재설치 후 처음부터 재설정



#### node-sass 설치 시 오류가 발생한다면



1. [node-sass 호환 node.js 버전](https://github.com/sass/node-sass#node-version-support-policy)을 확인해서 적절한 버전을 사용

2. `gyp: No Xcode or CLT version detected!` 라는 메시지와 함께 설치에 실패한다면 [관련 이슈](https://github.com/schnerd/d3-scale-cluster/issues/7)의 코멘트 참고



#### mysqlclient 설치 시 오류가 발생한다면



[email protected] ([5.7 버전이어야 하는 이유](https://stackoverflow.com/a/50342229)) 을 설치 후 PATH에 해당 실행 파일 디렉터리를 추가한다. 예를 들면 (macOS 기준),



```shell

$ brew install [email protected]

$ export PATH="/opt/homebrew/opt/[email protected]/bin:$PATH" # add this line to ~/.bashrc, .zshrc, etc.

```



#### 설정 완료 후 no-such-column 오류가 발생한다면



일부 조건에서 `no such column: main_famoushumanityreviewdailyfeed_reviews.review_id` 오류가 발생할 수 있음  

Working directory: `PROJECT_ROOT`



```shell

# DB 초기화

$ rm db.sqlite3

# DB migrate 재실행

$ python manage.py migrate main 0006

$ python manage.py migrate review 0009

$ python manage.py migrate

```



이후 [개발용 DB 설정](#개발용-db-설정-Optional) 재실행



#### (Apple Silicon) pip install에서 pyobdc가 설치되지 않는다면



```bash

/otlplus/include -arch arm64 -I/opt/homebrew/Caskroom/miniconda/base/envs/otlplus/include -arch arm64 -DPYODBC_VERSION=4.0.32 -UMAC_OS_X_VERSION_10_7 -I/opt/homebrew/Caskroom/miniconda/base/envs/otlplus/include/python3.8 -c src/buffer.cpp -o build/temp.macosx-11.1-arm64-3.8/src/buffer.o -Wno-write-strings -Wno-deprecated-declarations

      In file included from src/buffer.cpp:12:

      src/pyodbc.h:56:10: fatal error: 'sql.h' file not found

      #include 

               ^~~~~~~

      1 error generated.

      error: command '/usr/bin/gcc' failed with exit code 1

      [end of output]

  

  note: This error originates from a subprocess, and is likely not a problem with pip.

error: legacy-install-failure



× Encountered error while trying to install package.

╰─> pyodbc



note: This is an issue with the package mentioned above, not pip.

hint: See above for output from the failure.

```



[https://github.com/mkleehammer/pyodbc/issues/846#issuecomment-1122715983](https://github.com/mkleehammer/pyodbc/issues/846#issuecomment-1122715983) 참조



```sh

brew install unixodbc

export LDFLAGS="-L/opt/homebrew/lib"

export CFLAGS="-I/opt/homebrew/include"

export CPPFLAGS="-I/opt/homebrew/include"

pip install -r requirements.txt

```