Skip to content

Commit 72cb336

Browse files
committed
Add instructions for running using the Docker image
1 parent a438fe8 commit 72cb336

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

readme.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,27 @@ This is the source of Mesimä (pronounced Mesi-mah). It is a RESTful HTTP applic
88

99
Mesimä was created with ❤️ using [Django Rest Framework](https://www.django-rest-framework.org/) and [PostgreSQL](https://www.postgresql.org/).
1010

11+
# Quick Start
12+
13+
Since our Docker image is hosted on Github's container registry, it is possible to run the app using Dokcer, **without even cloning** the repository.
14+
15+
Note though, that the application will run using sqlite3 as it's database and *not* postgres. If you want to run the application using postgres,
16+
refer to [Delopment Instructions: Running the Application](#running-the-application).
17+
18+
First, create the database file, and store it inside a named volume `mesima-data`:
19+
20+
```
21+
docker run -e "DB=sqlite" --volume mesima-data:/backend --entrypoint "python" ghcr.io/amitkummer/mesima:latest manage.py migrate
22+
```
23+
24+
Then, simply run the app:
25+
26+
```
27+
docker run -e "DB=sqlite" -it -p 8080:8000 --volume mesima-data:/backend ghcr.io/amitkummer/mesima:latest
28+
```
29+
30+
Open a web broswer and navigate to `https://localhost:8080/api`. You should see DRF's browseable api client.
31+
1132
# Development Instructions
1233

1334
## Prerequisites

0 commit comments

Comments
 (0)