Ces instructions supposent que vous développez BookWyrm en utilisant Docker. Vous devrez installer Docker et docker-compose avant toute chose.
If you are contributing to BookWyrm in a dockerless development environment we would love for you to help us update this guide to include instructions for setting up a dockerless development environment.
git clone pour télécharger le code sur votre ordinateur.main branch, so ensure that is the branch you have checked out: git checkout main.env.example and .env.dev.example) into new files named .env and env.dev. En ligne de commande, vous pouvez le faire en tapant :cp .env.example .env
cp .env.dev.example .env.dev
Most environment variables are set in the .env file, used in production, but for some development workflows that is overridden by the env.dev file. When developing for BookWyrm, you will need both files.
./bw-dev create_secrets # Create the secrets file with random values. You only need to do this once.
./bw-dev dev up --build # Build and start development stack
./bw-dev rundev python manage.py admin_code # Shows the admin-code for initial setup. You only need to do this once.
http://localhost:1333. If you have removed the PORT value in .env.dev this will be http://localhost. If you have changed the port, swap out 1333 for the port you are using.Pour les curieux·ses : la commande ./bw-dev est un simple script shell qui exécute divers autres outils ; au lieu des commandes ci-dessus, vous auriez pu exécuter docker-compose build ou docker-compose up directement si vous le souhaitez. ./bw-dev les rassemble dans un seul endroit pour plus de commodité. Run it without arguments to get a list of available commands, read the documentation page for it, or open it up and look around to see exactly what each command is doing!
Si vous créez ou modifiez un modèle, vous changerez probablement la structure de la base de données. Pour que ces changements aient des effets, vous devrez utiliser la commande makemigrations de Django pour créer un nouveau fichier de migration Django, puis la commande migrate pour le migrer :
./bw-dev makemigrations
./bw-dev rundev python manage.py migrate
Chaque fois que vous éditez du CSS ou du JavaScript, vous devrez exécuter la commande collectstatic de Django pour que vos changements aient un effet :
./bw-dev rundev python manage.py collectstatic
Si vous avez installé yarn, vous pouvez exécuter yarn watch:static qui va exécuter automatiquement le script précédent à chaque fois qu'un changement se produit dans le répertoire bookwyrm/static.
Before submitting patch, you should check ruff and other formatting tools. For those to work nicely, you should make sure you have development web-container and dev-tools build.
./bw-dev dev build # This is needed only once, if you haven't run dev stack previously
./bw-dev dev build dev-tools # This is needed only once and if you change pyproject.toml or Dockerfile
After those commands, you can run formatters and pytest and mypy with bw-dev command:
./bw-dev formatters
./bw-dev mypy
./bw-dev pytest
In .env.dev:
DOMAIN to to the domain name you are using (e.g. abcd-1234.ngrok-free.app).PORT=1333).Check that you have all the required settings configured before proceeding.
If you try to register your admin account and see a message that CSRF verification failed you may have set your domain or port incorrectly.
If you want to test sending emails, you will need to set up appropriate real values in the "Email config" section. You do not need to change anything for the separate EMAIL setting. These settings are in .env -file