2.1 KiB
Executable file
🍔 moku.blog
moku.blog is a small-web community for food enthusiasts.
🥐 behind the name
moku is the toki pona word for "food", "drink", "eat" or, really, anything to do with consuming. it comes from the japanese onomatopoeia もぐもぐ (mogu-mogu) which represents the sound of chewing.
🍕 contributing
it's great that you want to help out! a good place to start is checking in issues to see if what you're thinking about has already been discussed.
pre-requisites
- python 3.12 and poetry
- postgresql
setting up the environment
the environment is all managed by poetry so it's pretty easy to get started once you have poetry set up.
poetry install --with dev,test
if you get an error about psycopg2, make sure you have the system package libpq-dev installed on your system.
code-style
all our code is linted and formatted by ruff so it's important to make sure any changes you make are compliant.
poetry run ruff check .
poetry run ruff format --check .
if you want ruff to auto-format your code, you can use poetry run ruff format .
🧁 license
moku.blog's code is licensed under the bsd 2-clause license, which more or less means you're free to do whatever you want with it so long as any copies or modifications you make are under the same license.