turkiye-api
A comprehensive REST API providing detailed information about Turkey's administrative divisions including provinces, districts, municipalities, neighborhoods and villages with demographic and geographical data.
파일 탐색기
최종 버전 다운로드 (.zip)- ci.yml
- FUNDING.yml
- districts.json
- municipalities.json
- neighborhoods.json
- provinces.json
- villages.json
- districts.json
- municipalities.json
- neighborhoods.json
- provinces.json
- villages.json
- dataset-files.ts
- dataset-meta.ts
- index.ts
- load-datasets.ts
- types.ts
- build-indexes.ts
- index-helpers.ts
- index.ts
- types.ts
- datasets.ts
- districts.ts
- index.ts
- municipalities.ts
- neighborhoods.ts
- provinces.ts
- villages.ts
- entities.ts
- errors.ts
- index.ts
- meta.ts
- queries.ts
- responses.ts
- dataset-service.ts
- district-service.ts
- index.ts
- municipality-service.ts
- neighborhood-service.ts
- province-service.ts
- village-service.ts
- fields.ts
- http-errors.ts
- include.ts
- index.ts
- normalize-text.ts
- pagination.ts
- postal-code-status.ts
- postal-code.ts
- query-validation.ts
- responses.ts
- sort.ts
- app.ts
- cache.ts
- logging.ts
- openapi.ts
- rate-limit.ts
- server.ts
- api-routes.test.ts
- build-indexes.test.ts
- dataset-service.test.ts
- load-datasets.test.ts
- .dockerignore
- .gitignore
- .prettierignore
- .prettierrc.json
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- Dockerfile
- LICENSE
- package-lock.json
- package.json
- PRIVACY.md
- README.md
- SECURITY.md
- SUPPORT.md
- TERMS.md
- tsconfig.json
# 설치 가이드
1. 코드 내려받기
git clone https://github.com/ubeydeozdmr/turkiye-api
깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.
cd turkiye-api
방금 내려받은 프로젝트 폴더 안으로 이동합니다.
2. Docker
쉬움 추천사전 준비물
- Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
- Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.
docker build -t turkiye-api .
Dockerfile을 기반으로 실행 가능한 이미지를 빌드합니다.
docker run --rm -p 3000:3000 turkiye-api
빌드된 이미지를 실제 컨테이너로 실행합니다.
터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.
이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.
3. Node.js
쉬움사전 준비물
npm install
package.json에 명시된 라이브러리들을 내려받아 설치합니다.
npm run dev
개발/실행 서버를 켭니다.
PORT=4000 HOST=127.0.0.1 npm run dev
개발/실행 서버를 켭니다.
npm run build
배포용으로 코드를 최적화해서 빌드 파일을 생성합니다.
npm start
개발/실행 서버를 켭니다.
명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.
이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.
// repository documentation
Was this content helpful?
(0 ratings)