Skip to content

Commit

Permalink
Add setup steps to the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ulgens committed Jan 29, 2025

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
1 parent bdca327 commit 9fbadcf
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -2,9 +2,15 @@

Django development playground. It's for when you need to try something but the project in front of you is too complex / big / important to test stuff on it. Can be used as project starter if you have that kind of energy.

* Before the first run, copy `.env.dist` to `.env` and update it as you like.
* For docker build, [Buildkit](https://docs.docker.com/develop/develop-images/build_enhancements/#to-enable-buildkit-builds) must be enabled. If Buildkit is not enabled system or user wide, docker related commands should be called like
`DOCKER_BUILDKIT=1 make build` or `DOCKER_BUILDKIT=1 docker-compose build`
## Setup
> Make sure that you have an up to date version of Docker and `make` is installed.
* Copy `.env.dist` to `.env` and update it as you need.
* Run `make build` to build docker compose services.
* Run `make init_data` to initialize the database and create a superuser.
* Run `make up` to start the project.

The project homepage can be accessed at `http://localhost:8000/`.

# Contribution

0 comments on commit 9fbadcf

Please sign in to comment.