Skip to content

Latest commit

 

History

History
71 lines (47 loc) · 1.42 KB

README.md

File metadata and controls

71 lines (47 loc) · 1.42 KB

ondo

This is a quick and dirty fast api + htmx implementation of my personal website. It integrates with the IPLD based CMS that I built for myself here.

Check out the live site to see it in action.

requirements

  • python 3.12
  • tailwindcss@3 (install with npm install -g tailwindcss@3)
  • virtualenv
  • ruby and kamal (for deployments)

setup

git clone https://github.com/amiller68/ondo.git
cd ondo
# setup virtualenv and install dependencies
./bin/install.sh
# run the dev server
./bin/dev.sh

server should be running locally at http://localhost:8000

maintenance

format code:

./bin/fmt.sh

run linters:

./bin/lint.sh

run type checkers:

./bin/types.sh

run all checks:

./bin/checks.sh

styling

we use tailwindcss for styling. be sure to run ./bin/tailwind.sh to build the css when you make changes to tailwind.config.js or styles/main.css.

deploying

Be sure to setup an appropriate DOCKERHUB_TOKEN in your environment for the configured container registry.

Then just run kamal deploy:

kamal deploy

See the kamal docs for more information.

CI/CD is fully automated in this repo, so no need to worry about it. Pushing to main will deploy to the live site.