README.md

Assignment3

원티드 프리 온보딩 2주차 기업형 과제(원티드랩)

설명

본 프로젝트는 원티드x위코드 백엔드 프리온보딩 [원티드랩]에서 출제한 과제를 기반으로 제작 되었습니다.

과제 소개

요구사항 분석

REST API 기능

• 회사명 자동완성
• 회사 이름으로 회사 검색
• 새로운 회사 추가
• 데이터 셋 wanted_temp_data.csv
• 제공되는 test case를 통과할 수 있도록 개발해야 합니다. test_app.py

사용 스택

         

DB 스키마

문제정의 및 시퀀스 다이어그램

문제 정의
회사 이름으로 회사 검색 & 회사명 자동완성
새로운 회사 추가

과제 구현사항

구현사항	구현 여부
회사명 자동완성	OK
회사 이름으로 회사 검색	OK
새로운 회사 추가	OK

API

API문서

API 테스트

1. 우측 링크를 클릭해서 postman으로 들어갑니다.링크
2. 정의된 flask가 올바른지 확인 합니다.(3.36.88.48:5000)

3. 이후, API 테스트를 시도해 주세요.

설치 및 실행 방법

프로젝트 설치

git clone https://github.com/Wanted-Free-Pre-Onboarding-Course-10/Assignment3.git

환경 구축

#도커 환경 구축#
docker-compose up

#윈도우#
python -m venv venv

source venv/Scripts/activate

pip install -r requirements.txt

#맥#
python -m venv venv

source venv/bin/activate

pip install -r requirements.txt

flask db init
flask db migrate
flask db upgrade

flask run

팀원

이름	github	담당 역할	회고록
박지율	earthkingman	자동 완성 API, 도커, 캐싱 전략	회고록
염재선	Yeom Jae Seon	자동 완성 API, 개발 환경 설정, DB 설계, 서버 배포	회고록
김태희	김태희	회사 추가 API, 테스팅, DB 설계	회고록
박상엽	큰형	검색 API, 테스팅, 캐싱 전략	회고록

개발 일정

사전 학습

새로운 기술을 사용하기 전에 서로 다른 주제를 가지고 동료 학습을 진행했습니다.

협업 방식

잡초 협업하기

개발 과정

1.회사명 자동완성 API 바로가기

2. 회사 이름으로 회사 검색 API 바로가기

3. 새로운 회사 추가 API 바로가기

4. 캐싱 전략 바로가기

테스트

gif파일이 너무 커서 풀버전의 gif를 올리지 못하고 있습니다. 해당 gif풀버전은 김태희가 가지고 있습니다.

개발도중 고민들

• 테이블간의 관계, 다대다 vs 다대일의 고민(위키 링크)
• 도커의 도입 (위키 링크)
• 레디스의 도입 (위키 링크)