fastapi-starter
A FastAPI based low code starter/boilerplate: SQLAlchemy 2.0 (async), Postgres, React-Admin, pytest and cypress
파일 탐색기
최종 버전 다운로드 (.zip)- cookiecutter-project-test.yml
- deploy-demo.yml
- pre-commit.yaml
- dependabot.yml
- items.png
- login.png
- deploy-demo-project-to-fly.sh
- fly.toml
- test.sh
- pre-commit.yaml
- test.yaml
- dependabot.yml
- 5c89a726934c_add_item_migration.py
- 7e09fa75df7a_add_initial_migration.py
- env.py
- README
- script.py.mako
- __init__.py
- items.py
- users.py
- utils.py
- config.py
- logger.py
- db.py
- request_params.py
- users.py
- __init__.py
- item.py
- user.py
- item.py
- msg.py
- request_params.py
- user.py
- db.py
- factory.py
- index.html
- __init__.py
- test_items.py
- test_utils.py
- test_user.py
- __init__.py
- conftest.py
- utils.py
- alembic.ini
- Dockerfile
- main.py
- poetry.lock
- pyproject.toml
- shell.py
- app.cy.js
- index.js
- commands.js
- e2e.js
- favicon.ico
- index.html
- logo192.png
- logo512.png
- manifest.json
- robots.txt
- AdminLayout.tsx
- Auth.tsx
- authStyles.tsx
- FILES
- VERSION
- auth-api.ts
- items-api.ts
- users-api.ts
- bearer-response.ts
- detail.ts
- error-model.ts
- httpvalidation-error.ts
- index.ts
- item-create.ts
- item-update.ts
- item.ts
- user-create.ts
- user-read.ts
- user-update.ts
- validation-error-loc-inner.ts
- validation-error.ts
- .gitignore
- .npmignore
- .openapi-generator-ignore
- api.ts
- base.ts
- common.ts
- configuration.ts
- git_push.sh
- index.ts
- Dashboard.test.tsx
- Dashboard.tsx
- Items.tsx
- Login.test.tsx
- Login.tsx
- ProfileEdit.tsx
- Register.test.tsx
- Register.tsx
- Users.tsx
- authProvider.ts
- env.ts
- App.css
- App.tsx
- index.css
- index.tsx
- logo.svg
- react-app-env.d.ts
- reportWebVitals.ts
- setupTests.ts
- .dockerignore
- .gitignore
- .prettierignore
- cypress.config.ts
- Dockerfile
- nginx.conf
- openapitools.json
- package.json
- README.md
- tsconfig.json
- yarn.lock
- .dockerignore
- .env
- .gitignore
- .isort.cfg
- .pre-commit-config.yaml
- docker-compose.ci.yml
- docker-compose.override.yml
- docker-compose.yml
- Dockerfile
- env-template
- README.md
- .all-contributorsrc
- .gitignore
- .pre-commit-config.yaml
- cookiecutter.json
- LICENSE
- README.md
🚀 설치 가이드
1. 코드 내려받기
git clone https://github.com/gaganpreet/fastapi-starter
깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.
cd fastapi-starter
방금 내려받은 프로젝트 폴더 안으로 이동합니다.
2. 공식 설치 스크립트
쉬움 추천사전 준비물
- Python 3 pip 명령어를 쓰려면 Python이 필요합니다.
pip3 install cookiecutter
PyPI에 배포된 패키지를 바로 설치합니다. 소스 클론이 필요 없습니다.
pip3 install cruft
PyPI에 배포된 패키지를 바로 설치합니다. 소스 클론이 필요 없습니다.
설치 후 새 터미널을 열고, 프로그램의 버전 확인 명령(예: --version)으로 정상 설치됐는지 확인하세요.
이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.
3. Docker
쉬움사전 준비물
- Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
- Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.
docker compose -f {{cookiecutter.project_slug}}/docker-compose.ci.yml up -d --build
compose 설정 파일에 정의된 서비스들을 대상으로 명령을 실행합니다.
터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.
4. Node.js
쉬움사전 준비물
⚠️ 이 프로젝트는 규모가 큰 저장소라, 이 방법이 실제 핵심 제품이 아니라 내부 하위 패키지를 가리키는 것일 수 있습니다. README 전체를 함께 확인해보세요.
cd {{cookiecutter.project_slug}}/frontend
이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.
npm install
package.json에 명시된 라이브러리들을 내려받아 설치합니다.
npm start
개발/실행 서버를 켭니다.
명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.
5. Python
쉬움사전 준비물
pip3 install cookiecutter
PyPI에 배포된 패키지를 바로 설치합니다. 소스 클론이 필요 없습니다.
pip3 install cruft
PyPI에 배포된 패키지를 바로 설치합니다. 소스 클론이 필요 없습니다.
에러 메시지 없이 실행되고 터미널에 안내 문구가 출력되면 정상입니다.
이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.
// repository documentation
Was this content helpful?
(0 ratings)