Skip to content

Latest commit

Β 

History

History
101 lines (85 loc) Β· 2.76 KB

File metadata and controls

101 lines (85 loc) Β· 2.76 KB

πŸŒ‹ VolcanoAPI πŸŒ‹


πŸ₯ How do I start?


  • πŸ¦‹ Execute these commands
# Create image of volcano-api
$ docker-compose build

# Create pyproject.toml file that writes FastAPI and uvicorn[standard] by using poetry (poetry is like pip) And say yes at every time
$ docker-compose run \
  --entrypoint "poetry init \
    --name volcano-api \
    --dependency fastapi \
    --dependency uvicorn[standard]" \
  volcano-api

# Install dependencies that was written in pyproject.toml file
$ docker-compose run --entrypoint "poetry install --no-root" volcano-api

# Install all dependencies to Docker environment
$ docker-compose build --no-cache

🌳 Folder Structure

└── πŸ“volcano
    └── __init__.py
    └── πŸ“api
        └── __init__.py
        └── πŸ“v1
            └── __init__.py
            └── πŸ“endpoints
                └── __init__.py
                └── auth.py
                └── todo.py
                └── user.py
            └── routes.py
    └── πŸ“core
        └── __init__.py
        └── auth_exception.py
        └── config.py
    └── πŸ“domain
        └── __init__.py
        └── πŸ“entity
            └── __init__.py
            └── todo.py
            └── user.py
        └── πŸ“repository
            └── auth.py
            └── todo.py
            └── user.py
    └── πŸ“infrastructure
        └── __init__.py
        └── πŸ“postgresql
            └── __init__.py
            └── database.py
            └── πŸ“dto
                └── __init__.py
                └── todo.py
                └── volcano_user.py
        └── πŸ“repository
            └── auth.py
            └── todo.py
            └── user.py
    └── main.py
    └── πŸ“use_case
        └── __init__.py
        └── auth.py
        └── πŸ“model
            └── auth.py
            └── todo.py
        └── todo.py
        └── user.py

πŸ¦• References