feat: Add awesome devcontainer intro and better readme

.devcontainer/devcontainer.json

@@ -1,41 +1,57 @@
 // For format details, see https://aka.ms/devcontainer.json. For config options, see the
 // README at: https://github.com/devcontainers/templates/tree/main/src/docker-existing-docker-compose
 {
-  "name": "Existing Docker Compose (Extend)",
-
+  "name": "Extend base docker-compose for development purposes",
   // Update the 'dockerComposeFile' list if you have more compose files or use different names.
   // The .devcontainer/docker-compose.yml file contains any overrides you need/want to make.
-  "dockerComposeFile": ["../docker-compose.yml", "docker-compose.yml"],
-
+  "dockerComposeFile": [
+    "../docker-compose.yml",
+    "docker-compose.yml"
+  ],
   // The 'service' property is the name of the service for the container that VS Code should
   // use. Update this value and .devcontainer/docker-compose.yml to the real service name.
   "service": "web",
-
   // The optional 'workspaceFolder' property is the path VS Code should open by default when
   // connected. This is typically a file mount in .devcontainer/docker-compose.yml
   "workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",
   "features": {
-    "ghcr.io/wxw-matt/devcontainer-features/script_runner:0": {}
-  }
-
+    "ghcr.io/wxw-matt/devcontainer-features/script_runner:0": {},
+    "ghcr.io/devcontainers/features/git:1": {},
+    "ghcr.io/devcontainers/features/sshd:1": {}
+  },
   // Features to add to the dev container. More info: https://containers.dev/features.
   // "features": {},
-
   // Use 'forwardPorts' to make a list of ports inside the container available locally.
   // "forwardPorts": [],
-
   // Uncomment the next line if you want start specific services in your Docker Compose config.
   // "runServices": [],
-
   // Uncomment the next line if you want to keep your containers running after VS Code shuts down.
   // "shutdownAction": "none",
-
   // Uncomment the next line to run commands after the container is created.
-  // "postCreateCommand": "cat /etc/os-release",
-
+  "postStartCommand": "${containerWorkspaceFolder}/manage.py migrate",
+  "postCreateCommand": "${containerWorkspaceFolder}/manage.py collectstatic",
+  "customizations": {
+    "vscode": {
+      "settings": {
+        "extensions": {
+          "verifySignature": false
+        }
+      },
+      "settings.extensions.verifySignature": false,
+      "extensions": [
+        "ms-python.python",
+        "mikestead.dotenv",
+        "VisualStudioExptTeam.vscodeintellicode",
+        "ms-python.black-formatter",
+        "VisualStudioExptTeam.intellicode-api-usage-examples",
+        "ms-azuretools.vscode-docker",
+        "DavidAnson.vscode-markdownlint",
+        "yzhang.markdown-all-in-one"
+      ]
+    }
+  }
   // Configure tool-specific properties.
   // "customizations": {},
-
   // Uncomment to connect as an existing user other than the container default. More info: https://aka.ms/dev-containers-non-root.
   // "remoteUser": "devcontainer"
 }

.devcontainer/docker-compose.yml

@@ -1,28 +1,15 @@
-version: "3"
+version: "3.4"
 services:
-  # Update this to the name of the service you want to work with in your docker-compose.yml file
   web:
-    # Uncomment if you want to override the service's Dockerfile to one in the .devcontainer
-    # folder. Note that the path of the Dockerfile and context is relative to the *primary*
-    # docker-compose.yml file (the first in the devcontainer.json "dockerComposeFile"
-    # array). The sample below assumes your primary file is in the root of your project.
-    #
-    # build:
-    #   context: .
-    #   dockerfile: .devcontainer/Dockerfile
-
     volumes:
-      # Update this to wherever you want VS Code to mount the folder of your project
       - ..:/workspaces:cached
-
-    # Uncomment the next four lines if you will use a ptrace-based debugger like C++, Go, and Rust.
-    # cap_add:
-    #   - SYS_PTRACE
-    # security_opt:
-    #   - seccomp:unconfined
+    restart: unless-stopped
 
     # Overrides default command so things don't shut down after the process ends.
     command: /bin/sh -c "while sleep 1000; do :; done"
+    env_file:
+      - path: "../.env"
+        required: false
     environment:
       - SPEJSTORE_ENV=dev
       - SPEJSTORE_DB_NAME=postgres
@@ -36,4 +23,5 @@ services:
       # - SPEJSTORE_MEDIA_ROOT=
       # - SPEJSTORE_REQUIRE_AUTH=true
       - SPEJSTORE_OAUTH_REDIRECT_IS_HTTPS=false
+      - SPEJSTORE_SPEJSTORE_FILE_STORAGE_TYPE="filesystem"
       # - SPEJSTORE_PROXY_TRUSTED_IPS=172.21.37.1

.dockerignore

@@ -20,3 +20,4 @@ log
 .Dockerfile
 .env
 .devcontainer
+readme

.gitignore

@@ -15,3 +15,6 @@ build_static
 .vscode
 
 __pycache__
+
+# Is not ignored by default in devcontainers, macs bad
+.DS_Store

README.md

@@ -1,33 +1,46 @@
-# spejstore
+# spejstore (AKA inventory)
+
+The general HSWAW (and other polish hackerspaces) inventory system.
 
 Because there is not enough general inventory software invented here yet.
-Please use Python3, for the love of `$deity`...
 
 ## Usage
 
-### Quick start
+### Quick start (VSCode)
 
-1. Run:
-   ```sh
-   ln -s docker-compose.dev-override.yml docker-compose.override.yml
-   docker-compose up --build
-   ```
-2. Run `docker-compose run --rm web python manage.py createsuperuser` -- now you can dev authenticate w/o SSO
+1. Copy `.env.example` as `.env`
+2. Have `docker compose` 2.0. You can identify it by having `docker compose` command instead of `docker-compose`.
+3. Customize your `.env` for your specific usecase.
 
-### Build & run
+#### VSCode
 
-```sh
-docker-compose up --build
+0. Setup environment variables
+1. Get VSCode from [here](https://code.visualstudio.com/download), *CAN NOT* be VSCodium, as the extension is a microsoft binary which does not work with VSCodium.
+2. Install [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension
+3. Clone the repository and open it with VSCode.
+4. You should get a toast like this when re-opening directory with the cloned repository. ![Toast example](readme/toast-example.png 'Toast example')
+   1. If you don't get a toast, then use (CMD|Ctrl)+Shift+P to open actions menu and choose option **Rebuild Without Cache and Reopen in Container**. ![Command example](readme/command-example.png 'Command example')
+5. Reopen the directory in container either via command or popup button.
+6. Wait for the application and container to properly build.
+   1. Devcontainer's VSCode instance will be automatically configured with extensions to help your development process.
+   2. You might get a Toast telling you to re-open the directory due to Black not working properly. Do so for proper autoformatting support.
+7. `manage.py migrate` will be run automatically after container creation, to make sure you have the latest migrations done on the development database without any need for interaction.
+8. Run debug session with either command of "Start Debugging" (default hotkey F5), or with the Debug sidebar. ![Debug sidebar instructions](readme/debug-example.png 'Debug sidebar')
+9. You should have automatically forwarded ports, so the only thing remaining is opening browser window with the url provided in terminal.
 
-# if you need to reset built static files and/or postgres database:
-docker-compose up --build --renew-anon-volumes
-```
+#### Everything else (docker)
 
-### Troubleshooting
+1. Run `docker compose up`. This will create a production-ready setup with gunicorn. out of the box.
 
-- https://askubuntu.com/q/615394/413683
+### Everything else (python)
 
-## New docs (WIP):
+1. Get python3
+2. `pip install -r requirements.txt`
+3. `python3 manage.py migrate`
+4. `python3 manage.py collecstatic`
+5. `python3 manage.py runserver 0.0.0.0:8000`
+
+## New docs (WIP)
 
 Spejstore is a simple inventory system made for Warsaw Hackerspace purposes. Includes some features very specific to hswaw requirements, which are:
 

docker-compose.yml

@@ -2,7 +2,9 @@ version: "3"
 services:
   db:
     image: postgres:15.4
-    restart: always
+    restart: unless-stopped
+    volumes:
+      - spejstore-db:/var/lib/postgresql/data
     environment:
       - POSTGRES_USER=postgres
       - POSTGRES_PASSWORD=postgres
@@ -16,13 +18,18 @@ services:
 
   web:
     build: .
-    restart: always
+    restart: unless-stopped
     command: bash -c "python manage.py collectstatic --no-input --clear && python manage.py migrate && gunicorn --workers 1 --threads 4 -b 0.0.0.0:8000 --capture-output --error-logfile - --access-logfile - spejstore.wsgi:application"
     volumes:
       - .:/code
       - /code/build_static
     ports:
       - "8000:8000"
+    env_file:
+      - .env
     depends_on:
       db:
         condition: service_healthy
+volumes:
+  spejstore-db:
+    external: false