Installation
dart pub global activate dox
Create a new project
dox create new_blog
Export bin path
Please make sure you have included bin
path to your profile. If you did not added path to your profile yet, open ~/.bashrc
or ~/.zshrc
and paste below line.
export PATH="$PATH":"~/.pub-cache/bin"
Create a specific version
dox create new_blog --version v2.0.0
Or download from github
https://github.com/dartondox/dox-sample/archive/refs/tags/v2.0.0.zip
Start server
dox s
or
bin/dox s
Start server with docker
docker-compose up -d --build
Tips
Ensure that setting APP_ENV
in .env
to development
facilitates server operations with hot reloading during development, while configuring it as production
ensures compilation into machine code for server deployment.
Watch the builder
dart run build_runner watch
or
dox build_runner:watch