devbox_demo

Devbox demo for the OKC WebDevs Tool Talks hosted by Clevyr.

Minimum Requirements

• macOS, Linux, or WSL
• devbox

Recommended Requirements

• Docker
  • While devbox can run PostgreSQL as a plugin, it's more efficient to run it in a container while developing the frontend/backend of an application.

Quickstart

1. Clone this repository:

   git clone https://github.com/pythoninthegrass/devbox_demo.git && cd devbox_demo

2. Run devbox shell
3. Start services¹
   • devbox services up (terminal user interface)
   • devbox services start (daemon)
4. Navigate to localhost:5000 in your browser
5. Stop services with either devbox services stop or F10 in the TUI
6. Deactivate the shell with exit

Development

# run tests
devbox run test

# add packages
devbox search <package>
devbox add <package>            # add latest package
devbox add <package>@<version>  # add specific version

# remove packages
devbox remove <package>

# use poetry to get all dependencies
devbox shell
poetry shell
poetry install

# update requirements
poetry add <package>

# export requirements.txt (uv/pip compatibility)
devbox run export

TODO

• Fix Tailwind CSS styling
• Add a database
• Add taskfile
• Add CI/CD using devbox

Further Reading

• devbox docs
• process-compose
• Orchestrate your Dev Environment using Devbox
• postgres docker image
• flask
• tailwindcss

Footnotes

1. devbox shell does not natively read the .env file the same way as docker compose. Use devbox shell --env-file .env to pass the .env file to the shell. ↩