knutschsoft/swapp

streetworker app

Maintainers

Details

github.com/knutschsoft/swapp

Source

Issues

Installs: 0

Dependents: 0

Suggesters: 0

Security: 0

Stars: 5

Watchers: 7

Forks: 2

Open Issues: 10

Language:Vue

Type:project

dev-develop / 1.0.x-dev 2024-12-04 14:08 UTC

Requires

Requires (Dev)

Conflicts

MIT fdd2445e972d1b9ca7c49a75bf4a6528990f1e6f

This package is auto-updated.

Last update: 2024-12-04 14:09:34 UTC

README

Software License Open Issues Closed Issues Contributors Contributors

Swapp is a project to ease documentation of streetworkers which are on their way.

Have a look at https://streetworkapp.de/ for more information.

See https://swapp.demo.streetworkapp.de for a full working demo of Swapp.

Was ist Swapp? What is Swapp?

How to start local dev?

  1. Setup a proxy with nginx (which includes docker-gen)

    Place the following docker-compose.yml in the folder of your choice, e.g. /var/apps/nginx-proxy/ or /<your-home-dir>/workspace/nginx-proxy/.

    version: "3.4"

services:
    nginx-proxy:
        image: jwilder/nginx-proxy:alpine
        container_name: nginx-proxy
        ports:
            - target: 80
              published: 80
              protocol: tcp
            - target: 443
              published: 443
              protocol: tcp
        volumes:
            - /var/run/docker.sock:/tmp/docker.sock:ro
            - ./certs:/etc/nginx/certs
            - ./vhosts:/etc/nginx/conf.d
        networks:
            - swapp-dev

networks:
    swapp-dev:
       external: true
  2. Install local ssl certificates

    The following could be automated with own Dockerfile including jwilder/nginx-proxy and mkCert - alike to dev-tls docker file.

    First you have to settle on a domain to use for swapp. We will use swapp.local in the following expamples. Using only swapp would be troubling for certificates since most browsers do not accept wildcard certificates for second-level domains: e.g. browser will not accept certs created with *.swapp for subdomain api.swapp

    install mkCert
    # linux
wget https://github.com/FiloSottile/mkcert/releases/download/v1.4.1/mkcert-v1.4.1-linux-amd64
sudo mv mkcert-v1.4.1-linux-amd64 /usr/local/bin/mkcert
sudo chmod +x /usr/local/bin/mkcert
    # macOS
brew install mkcert
brew install nss # if you use Firefox
    Install rootCA

    This automatically adds mkcert's rootCA to your systems trusted CAs so you no longer will be bugged by untrusted certificate notifications in your local browser.

    mkcert --install
    create Certs

    Navigate to the nginx-proxy certs volume e.g. cd /var/apps/nginx-proxy/certs or /<your-home-dir>/workspace/nginx-proxy/certs

    mkcert -key-file swapp.local.key -cert-file swapp.local.crt swapp.local *.swapp.local

    This generates a certificate for all subdomains of swapp.local

  3. setup dns
    # /etc/hosts
127.0.0.1	swapp.local
  4. start nginx-proxy
    # this need to be run only once 
docker network create swapp-dev
    # /var/apps/nginx-proxy/ or /<your-home-dir>/workspace/nginx-proxy/
docker-compose up -d
  5. create .env
    #<yourWorkSpace>/swapp
cp .env.dist .env

    Adjust sensible vars like e.g. JWT_KEY and DB_PASSWORD as needed. Make sure the DOMAIN_NAME matches the one used when creating certificates.

  6. add in your .bashrc (or .zshrc)
    $ vi ~/.bashrc

...
export HOST_UID=$(id -u)      # UID is now available for docker-compose.yml
export HOST_GID=$(id -g)      # GID is now available for docker-compose.yml
  7. start swapp stack
    docker-compose up -d

    nginx-proxy will create a vhost entry for each of swapp's services which has an environment variable VIRTUAL_HOST set. You can check the created hosts in a volume:

    cat path-to-nginx-proxy/vhosts/default.conf
  8. access swapp
    via domain names with self signed certificates

    Advantage: There is no need to accept insecure certs on every first website request.

    To access with your mobile devices in your local WAN you have to replace 'swapp.local' with your local ip address:

    • Find local ip address in Windows 7 [1]
    • Find local ip address in Ubuntu [1] [2]
  9. optional: use XDebug
    • Activate XDebug in .env: 
      PHP_XDEBUG_ENABLED=1
    • PHPStorm setup:
      • Settings... -> Languages & Frameworks -> PHP -> Servers: Add
        • name: has to be same as PHP_IDE_CONFIG value
        • port: 80
        • path-mapping: path of project root in host system
      • Setting -> Languages & Frameworks -> PHP -> Debug -> DBGp Proxy:
        • Port: 9000
    • Start containers: 
      $ docker-compose up -d
    • After clicking "Start Listening for PHP Debug Connections" in PHPStorm you can jump to web and cli breakpoints.
    • To activate/deactivate XDebug simply adjust ENV-Variable PHP_XDEBUG_ENABLED in docker-compose.yml and restart containers (docker-compose down && docker-compose up -d)

Cheat Sheet

  • Execute symfony command 
    $ docker-compose exec web php bin/console [SF-CONSOLE-COMMAND]
  • Start webpack encore 
    $ docker-compose exec web node_modules/.bin/encore dev-server
  • Show containers and their status 
    $ docker-compose ps
  • Container shell access 
    $ docker-compose exec web bash
  • CLI connection to MySQL: 
    $ mysql -u swapp -p -hmysql
  • Stop services/container 
    $ docker-compose stop
  • Stop and delete container (incl. volumes, images und networks except data volumes) 
    $ docker-compose down