Merge pull request #122 from kristo-baricevic/help-page

Help page
CodeForPhilly · Apr 12, 2024 · 091a576 · 091a576
2 parents 72c1c69 + b6ea4cc
commit 091a576
Show file tree

Hide file tree

Showing 26 changed files with 555 additions and 977 deletions.
diff --git a/.github/workflows/containers-publish.yml b/.github/workflows/containers-publish.yml
@@ -1,125 +0,0 @@
-<<<<<<< HEAD
-name: 'Containers: Publish'
-
-on:
-  push:
-    tags: [ 'v*' ]
-=======
-name: "Containers: Publish"
-
-on:
-  push:
-    tags: ["v*"]
->>>>>>> afb000d3a3ee90a677a2580d82fe3a432d1c1933
-
-permissions:
-  packages: write
-
-jobs:
-  release-containers:
-    name: Build and Push
-    runs-on: ubuntu-latest
-    steps:
-<<<<<<< HEAD
-
-    - uses: actions/checkout@v3
-
-    - name: Login to ghcr.io Docker registry
-      uses: docker/login-action@v2
-      with:
-        registry: ghcr.io
-        username: ${{ github.repository_owner }}
-        password: ${{ secrets.GITHUB_TOKEN }}
-
-    - name: Compute Docker container image addresses
-      run: |
-        DOCKER_REPOSITORY="ghcr.io/${GITHUB_REPOSITORY,,}"
-        DOCKER_TAG="${GITHUB_REF:11}"
-
-        echo "DOCKER_REPOSITORY=${DOCKER_REPOSITORY}" >> $GITHUB_ENV
-        echo "DOCKER_TAG=${DOCKER_TAG}" >> $GITHUB_ENV
-
-        echo "Using: ${DOCKER_REPOSITORY}/*:${DOCKER_TAG}"
-
-    # - name: 'Pull previous Docker container image: :latest'
-    #   run: docker pull "${DOCKER_REPOSITORY}:latest" || true
-
-    - name: 'Pull previous Docker container image: frontend-static:latest'
-      run: docker pull "${DOCKER_REPOSITORY}/frontend-static:latest" || true
-
-    - name: 'Build Docker container image: frontend-static:latest'
-      run: |
-        docker build \
-            --cache-from "${DOCKER_REPOSITORY}/frontend-static:latest" \
-            --file frontend/Dockerfile.demo \
-            --build-arg SERVER_NAME=localhost \
-            --tag "${DOCKER_REPOSITORY}/frontend-static:latest" \
-            --tag "${DOCKER_REPOSITORY}/frontend-static:${DOCKER_TAG}" \
-            frontend
-    - name: 'Push Docker container image frontend-static:latest'
-      run: docker push "${DOCKER_REPOSITORY}/frontend-static:latest"
-
-    - name: 'Push Docker container image frontend-static:v*'
-      run: docker push "${DOCKER_REPOSITORY}/frontend-static:${DOCKER_TAG}"
-=======
-      - uses: actions/checkout@v3
-
-      - name: Login to ghcr.io Docker registry
-        uses: docker/login-action@v2
-        with:
-          registry: ghcr.io
-          username: ${{ github.repository_owner }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Compute Docker container image addresses
-        run: |
-          DOCKER_REPOSITORY="ghcr.io/${GITHUB_REPOSITORY,,}"
-          DOCKER_TAG="${GITHUB_REF:11}"
-
-          echo "DOCKER_REPOSITORY=${DOCKER_REPOSITORY}" >> $GITHUB_ENV
-          echo "DOCKER_TAG=${DOCKER_TAG}" >> $GITHUB_ENV
-
-          echo "Using: ${DOCKER_REPOSITORY}/*:${DOCKER_TAG}"
-
-      # - name: 'Pull previous Docker container image: :latest'
-      #   run: docker pull "${DOCKER_REPOSITORY}:latest" || true
-
-      - name: "Pull previous Docker container image: frontend-static:latest"
-        run: docker pull "${DOCKER_REPOSITORY}/frontend-static:latest" || true
-
-      - name: "Build Docker container image: frontend-static:latest"
-        run: |
-          docker build \
-              --cache-from "${DOCKER_REPOSITORY}/frontend-static:latest" \
-              --file frontend/Dockerfile.demo \
-              --build-arg SERVER_NAME=localhost \
-              --tag "${DOCKER_REPOSITORY}/frontend-static:latest" \
-              --tag "${DOCKER_REPOSITORY}/frontend-static:${DOCKER_TAG}" \
-              frontend
-      - name: "Push Docker container image frontend-static:latest"
-        run: docker push "${DOCKER_REPOSITORY}/frontend-static:latest"
-
-      - name: "Push Docker container image frontend-static:v*"
-        run: docker push "${DOCKER_REPOSITORY}/frontend-static:${DOCKER_TAG}"
->>>>>>> afb000d3a3ee90a677a2580d82fe3a432d1c1933
-#
-#
-#    - name: 'Build Docker container image: backend:latest'
-#      run: |
-#        cd backend && \
-#        make && \
-#        docker image tag "${DOCKER_REPOSITORY}/backend/local:latest" "${DOCKER_REPOSITORY}/backend:latest"
-#
-#    - name: Push Docker container image backend:latest
-#      run: docker push "${DOCKER_REPOSITORY}/backend:latest"
-#
-#    - name: Push Docker container image backend:v*
-#      run: docker push "${DOCKER_REPOSITORY}/backend:${DOCKER_TAG}"
-
-<<<<<<< HEAD
-    # - name: Push Docker container image :v*"
-    #   run: docker push "${DOCKER_REPOSITORY}:${DOCKER_TAG}"
-=======
-# - name: Push Docker container image :v*"
-#   run: docker push "${DOCKER_REPOSITORY}:${DOCKER_TAG}"
->>>>>>> afb000d3a3ee90a677a2580d82fe3a432d1c1933

diff --git a/.github/workflows/release-prepare.yml b/.github/workflows/release-prepare.yml
@@ -1,37 +0,0 @@
-<<<<<<< HEAD
-name: 'Release: Prepare PR'
-
-on:
-  push:
-    branches: [ develop ]
-=======
-name: "Release: Prepare PR"
-
-on:
-  push:
-    branches: [develop]
->>>>>>> afb000d3a3ee90a677a2580d82fe3a432d1c1933
-
-permissions:
-  contents: read
-  pull-requests: write
-
-jobs:
-  release-prepare:
-<<<<<<< HEAD
-
-    runs-on: ubuntu-latest
-    steps:
-
-    - uses: JarvusInnovations/infra-components@channels/github-actions/release-prepare/latest
-      with:
-        github-token: ${{ secrets.GITHUB_TOKEN }}
-        release-branch: main
-=======
-    runs-on: ubuntu-latest
-    steps:
-      - uses: JarvusInnovations/infra-components@channels/github-actions/release-prepare/latest
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          release-branch: main
->>>>>>> afb000d3a3ee90a677a2580d82fe3a432d1c1933

diff --git a/.github/workflows/release-publish.yml b/.github/workflows/release-publish.yml
@@ -1,33 +0,0 @@
-<<<<<<< HEAD
-name: 'Release: Publish PR'
-
-on:
-  pull_request:
-    branches: [ main ]
-    types: [ closed ]
-
-jobs:
-  release-publish:
-
-    runs-on: ubuntu-latest
-    steps:
-
-    - uses: JarvusInnovations/infra-components@channels/github-actions/release-publish/latest
-      with:
-        github-token: ${{ secrets.BOT_GITHUB_TOKEN }}
-=======
-name: "Release: Publish PR"
-
-on:
-  pull_request:
-    branches: [main]
-    types: [closed]
-
-jobs:
-  release-publish:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: JarvusInnovations/infra-components@channels/github-actions/release-publish/latest
-        with:
-          github-token: ${{ secrets.BOT_GITHUB_TOKEN }}
->>>>>>> afb000d3a3ee90a677a2580d82fe3a432d1c1933

diff --git a/.github/workflows/release-validate.yml b/.github/workflows/release-validate.yml
@@ -1,33 +0,0 @@
-<<<<<<< HEAD
-name: 'Release: Validate PR'
-
-on:
-  pull_request:
-    branches: [ main ]
-    types: [ opened, edited, reopened, synchronize ]
-
-jobs:
-  release-validate:
-
-    runs-on: ubuntu-latest
-    steps:
-
-    - uses: JarvusInnovations/infra-components@channels/github-actions/release-validate/latest
-      with:
-        github-token: ${{ secrets.GITHUB_TOKEN }}
-=======
-name: "Release: Validate PR"
-
-on:
-  pull_request:
-    branches: [main]
-    types: [opened, edited, reopened, synchronize]
-
-jobs:
-  release-validate:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: JarvusInnovations/infra-components@channels/github-actions/release-validate/latest
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
->>>>>>> afb000d3a3ee90a677a2580d82fe3a432d1c1933

diff --git a/Dockerfile.prod b/Dockerfile.prod
@@ -1,71 +0,0 @@
-###########
-# BUILDER #
-###########
-
-# pull official base image
-FROM python:3.11.4-slim-buster as builder
-
-# set work directory
-WORKDIR /usr/src/app
-
-# set environment variables
-ENV PYTHONDONTWRITEBYTECODE 1
-ENV PYTHONUNBUFFERED 1
-
-# install system dependencies
-RUN apt-get update && \
-    apt-get install -y --no-install-recommends gcc
-
-# lint
-# RUN pip install --upgrade pip
-# RUN pip install flake8==6.0.0
-# COPY . /usr/src/app/
-# RUN flake8 --ignore=E501,F401 .
-
-# install python dependencies
-COPY ./requirements.txt .
-RUN pip wheel --no-cache-dir --no-deps --wheel-dir /usr/src/app/wheels -r requirements.txt
-
-
-#########
-# FINAL #
-#########
-
-# pull official base image
-FROM python:3.11.4-slim-buster
-
-# create directory for the app user
-RUN mkdir -p /home/app
-
-# create the app user
-RUN addgroup --system app && adduser --system --group app
-
-# create the appropriate directories
-ENV HOME=/home/app
-ENV APP_HOME=/home/app/web
-RUN mkdir $APP_HOME
-WORKDIR $APP_HOME
-
-# install dependencies
-RUN apt-get update && apt-get install -y --no-install-recommends netcat
-COPY --from=builder /usr/src/app/wheels /wheels
-COPY --from=builder /usr/src/app/requirements.txt .
-RUN pip install --upgrade pip
-RUN pip install --no-cache /wheels/*
-
-# copy entrypoint.prod.sh
-COPY ./entrypoint.prod.sh .
-RUN sed -i 's/\r$//g'  $APP_HOME/entrypoint.prod.sh
-RUN chmod +x  $APP_HOME/entrypoint.prod.sh
-
-# copy project
-COPY . $APP_HOME
-
-# chown all the files to the app user
-RUN chown -R app:app $APP_HOME
-
-# change to the app user
-USER app
-
-# run entrypoint.prod.sh
-ENTRYPOINT ["/home/app/web/entrypoint.prod.sh"]

diff --git a/docker-compose.dev.yml b/docker-compose.dev.yml
@@ -1,75 +1 @@
-version: '3.8'
-services:
-  db:
-    image: postgres:15
-    volumes:
-      - postgres_data:/var/lib/postgresql/data/
-    environment:
-      - POSTGRES_USER=balancer
-      - POSTGRES_PASSWORD=balancer
-      - POSTGRES_DB=balancer_dev
-    ports:
-    - "5432:5432"
-    networks:
-      app_net:
-        ipv4_address: 192.168.0.2  
-  pgadmin:
-    container_name: pgadmin4
-    image: dpage/pgadmin4
-    environment:
-      PGADMIN_DEFAULT_EMAIL: balancer-noreply@codeforphilly.org
-      PGADMIN_DEFAULT_PASSWORD: balancer
-      # PGADMIN_LISTEN_PORT = 80
-    # volumes:
-    #   - ./pgadmin-data:/var/lib/pgadmin
-    #       # PGADMIN_LISTEN_PORT = 80
-    ports:
-      - "5050:80"
-    networks:
-      app_net:
-        ipv4_address: 192.168.0.3
-  backend:
-    image: balancer-backend
-    build: ./server
-    command: python manage.py runserver 0.0.0.0:8000
-    ports:
-      - "8000:8000"
-    env_file:
-      - ./config/env/env.dev
-    depends_on:
-      - db
-    volumes:
-      - ./server:/usr/src/server
-    networks:
-      app_net:
-        ipv4_address: 192.168.0.4
-  frontend:
-    image: balancer-frontend
-    build:
-      context: frontend
-      dockerfile: Dockerfile
-      args:
-        - IMAGE_NAME=balancer-frontend
-    ports:
-        - "3000:3000"
-    environment:
-        - CHOKIDAR_USEPOLLING=true
-        # - VITE_API_BASE_URL=https://balancertestsite.com/
-    volumes:
-        - "./frontend:/usr/src/app:delegated"
-        - "/usr/src/app/node_modules/"
-    depends_on:
-      - backend
-    networks:
-      app_net:
-        ipv4_address: 192.168.0.5
-
-volumes:
-  postgres_data:
-networks:
-  app_net:
-    ipam:
-      driver: default
-      config:
-        - subnet: "192.168.0.0/24"
           gateway: 192.168.0.1