inboard
π’ Docker images and utilities to power your Python APIs and help you ship faster. With support for Uvicorn, Gunicorn, Starlette, and FastAPI.
File Explorer
Download Latest Version (.zip)- baseline.json
- ci.yml
- CODE_OF_CONDUCT.md
- PULL_REQUEST_TEMPLATE.md
- extensions.json
- launch.json
- settings.json
- favicon.png
- inboard-logo.svg
- authentication.md
- changelog.md
- contributing.md
- docker.md
- environment.md
- index.md
- logging.md
- __init__.py
- main_base.py
- main_fastapi.py
- main_starlette.py
- prestart.py
- utilities_fastapi.py
- utilities_starlette.py
- __init__.py
- gunicorn_conf.py
- gunicorn_workers.py
- logging_conf.py
- py.typed
- start.py
- types.py
- __init__.py
- test_main.py
- __init__.py
- conftest.py
- test_gunicorn_conf.py
- test_gunicorn_workers.py
- test_logging_conf.py
- test_start.py
- test_types.py
- .dockerignore
- .gitattributes
- .gitignore
- .prettierignore
- .prettierrc
- CHANGELOG.md
- CONTRIBUTING.md
- cspell.json
- Dockerfile
- LICENSE
- pyproject.toml
- README.md
- vercel.json
- zensical.toml
# Installation Guide
1. Get the code
git clone https://github.com/br3ndonland/inboard
Downloads the entire project code from GitHub to your computer.
cd inboard
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t inboard .
Builds a runnable image based on the Dockerfile.
docker run -p 8080:80 inboard
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. Python
EasyPrerequisites
pip install .
Installs the package published on PyPI directly β no need to clone the source.
python <μ€νν νμΌλͺ
>.py # READMEμμ μ νν μ€ν νμΌλͺ
μ νμΈνμΈμ
Runs the Python script (or module).
If it runs without errors and prints output in the terminal, it worked.
// repository documentation
Was this content helpful?
(0 ratings)
