These instructions assume you are developing BookWyrm using Docker. You'll need to install Docker and docker-compose to get started.
git cloneto download the code to your computer.
.env.example) into a new file named
.env. In the command line, you can do this with:
cp .env.example .env
Optionally, you can use a service like ngrok to set up a domain name, and set the
DOMAIN variable in your
.env file to the domain name generated by ngrok.
Set up nginx for development by copying the developer nginx configuration file (
nginx/development) into a new file named
cp nginx/development nginx/default.conf
./bw-dev build # Build the docker images ./bw-dev setup # Initialize the database and run migrations ./bw-dev up # Start the docker containers
http://localhost:1333and create an admin user.
If you're curious: the
./bw-dev command is a simple shell script runs various other tools: above, you could skip it and run
docker-compose build or
docker-compose up directly if you like.
./bw-dev just collects them into one common place for convenience. 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!
If you change or create a model, you will probably change the database structure. For these changes to have effect you will need to run Django's
makemigrations command to create a new Django migrations file, and then
./bw-dev makemigrations ./bw-dev migrate
collectstatic command again in order for your changes to have effect:
If you have installed yarn, you can run
yarn watch:static to automatically run the previous script every time a change occurs in