feat: add command to run migration before starting server, environment variables and README for database migrations (#264)

* feat: update environment variables and README for database migrations

* feat: update environment variables and docker-compose for PostgreSQL configuration

* feat: add --noinput flag to manage.py migrate command in Dockerfiles

Author: prakashchoudhary07

.env.example

@@ -31,8 +31,8 @@ SWAGGER_UI_PATH='/api/schema'
 
 ADMIN_EMAILS =  "[email protected],[email protected]"
 
-POSTGRES_HOST: postgres
-POSTGRES_PORT: 5432
-POSTGRES_DB: todo_postgres
-POSTGRES_USER: todo_user
-POSTGRES_PASSWORD: todo_password
+POSTGRES_DB=todo_postgres
+POSTGRES_HOST=postgres
+POSTGRES_PASSWORD=todo_password
+POSTGRES_PORT=5432
+POSTGRES_USER=todo_user

.gitignore

@@ -103,5 +103,7 @@ dmypy.json
 cython_debug/
 
 .ruff_cache
-mongo_data
-logs
+/mongo_data
+/logs
+
+/postgres_data

README.md

@@ -83,6 +83,28 @@
     ```
 4. On making changes to code and saving, live reload will work in this case as well
 
+## Database Migrations
+
+When making changes to Django models, you need to create and apply migrations:
+
+1. **Create migrations** (run this after modifying models):
+    ```
+    python manage.py makemigrations
+    ```
+
+2. **Apply migrations** (run this to update the database schema):
+    ```
+    python manage.py migrate
+    ```
+
+3. **In Docker environment:**
+    ```
+    docker compose exec django-app python manage.py makemigrations
+    docker compose exec django-app python manage.py migrate
+    ```
+
+**Note:** The docker-compose.yml automatically runs `migrate` on startup, but you must manually run `makemigrations` after model changes.
+
 ## Command reference
 1. To run the tests, run the following command
     ```

docker-compose.yml

@@ -4,13 +4,11 @@ services:
     container_name: todo-django-app
     command: >
       sh -c "
-        python manage.py makemigrations &&
-        python manage.py migrate &&
-        python manage.py shell -c 'from todo_project.db.init import initialize_database; initialize_database()' &&
-        python manage.py runserver 0.0.0.0:8000
+        python manage.py migrate  --noinput &&
+        python -Xfrozen_modules=off manage.py runserver_debug 0.0.0.0:8000 --debug-port 5678
       "
     environment:
-      MONGODB_URI: mongodb://db:27017
+      MONGODB_URI: mongodb://db:27017/?replicaSet=rs0
       DB_NAME: todo-app
       PYTHONUNBUFFERED: 1
       PYDEVD_DISABLE_FILE_VALIDATION: 1
@@ -36,39 +34,34 @@ services:
     tty: true
 
   postgres:
-    image: postgres:15
+    image: postgres:17.6
     container_name: todo-postgres
     environment:
       POSTGRES_DB: todo_postgres
       POSTGRES_USER: todo_user
       POSTGRES_PASSWORD: todo_password
-      POSTGRES_HOST_AUTH_METHOD: trust
     ports:
       - "5432:5432"
     volumes:
       - postgres_data:/var/lib/postgresql/data
-      - ./init-scripts:/docker-entrypoint-initdb.d
     healthcheck:
       test:
         [
           "CMD-SHELL",
-          "pg_isready -U todo_user -d todo_app && echo 'Postgres healthcheck passed'",
+          "pg_isready -U ${POSTGRES_USER} -d ${POSTGRES_DB}",
         ]
       interval: 10s
       timeout: 5s
       retries: 5
-      start_period: 10s
-
-
 
   db:
     image: mongo:latest
-    command: ["--replSet", "rs0", "--bind_ip_all", "--port", "27017"]
+    command: ["--replSet", "rs0", "--bind_ip_all", "--port", "27017", "--quiet"]
     container_name: todo-mongo
     ports:
       - "27017:27017"
     volumes:
-      - ./mongo_data:/data/db
+      - mongo_data:/data/db
     healthcheck:
       test:
         [
@@ -119,3 +112,4 @@ services:
 
 volumes:
   postgres_data:
+  mongo_data:

production.Dockerfile

@@ -58,4 +58,4 @@ COPY . .
 EXPOSE 8000
 
 # Run the application.
-CMD ["gunicorn", "todo_project.wsgi", "--bind", "0.0.0.0:8000"]
+CMD ["sh", "-c", "python manage.py migrate --noinput && gunicorn todo_project.wsgi --bind 0.0.0.0:8000"]