Merge timed-backend

.editorconfig

@@ -17,3 +17,6 @@ insert_final_newline = false
 
 [*.{diff,md}]
 trim_trailing_whitespace = false
+
+[*.py]
+indent_size  = 4

.github/dependabot.yml

@@ -8,11 +8,31 @@ updates:
       time: "12:00"
       timezone: "Europe/Zurich"
   - package-ecosystem: npm
-    directory: "/"
+    directory: "/frontend"
     schedule:
       interval: "weekly"
       day: "friday"
       time: "12:00"
       timezone: "Europe/Zurich"
     open-pull-requests-limit: 10
     versioning-strategy: increase
+  - package-ecosystem: pip
+    directory: "/backend"
+    schedule:
+      interval: weekly
+      day: friday
+      time: "12:00"
+      timezone: "Europe/Zurich"
+    commit-message:
+      prefix: chore
+      include: scope
+  - package-ecosystem: docker
+    directory: "/"
+    schedule:
+      interval: weekly
+      day: friday
+      time: "12:00"
+      timezone: "Europe/Zurich"
+    commit-message:
+      prefix: chore
+      include: scope

.github/workflows/release-image.yml

@@ -1,4 +1,4 @@
-name: Release ghcr image
+name: Release ghcr images
 
 on:
   release:
@@ -7,6 +7,9 @@ on:
 jobs:
   container:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        target: [frontend, backend]
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -15,11 +18,11 @@ jobs:
         id: meta
         uses: docker/metadata-action@v5
         with:
-          images: ghcr.io/adfinis/timed-frontend
+          images: ghcr.io/adfinis/timed-${{ matrix.target }}
           flavor: |
             latest=auto
           labels: |
-            org.opencontainers.image.title=${{ github.event.repository.name }}
+            org.opencontainers.image.title=${{ github.event.repository.name }}-${{ matrix.target }}
             org.opencontainers.image.description=${{ github.event.repository.description }}
             org.opencontainers.image.url=${{ github.event.repository.html_url }}
             org.opencontainers.image.source=${{ github.event.repository.clone_url }}
@@ -38,7 +41,7 @@ jobs:
         uses: docker/build-push-action@v5
         with:
           context: .
-          file: ./Dockerfile
+          file: ./${{ matrix.target }}/Dockerfile
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta.outputs.tags }}
           labels: |

.github/workflows/release-npm.yml

@@ -2,6 +2,9 @@ name: Release npm package
 
 on: workflow_dispatch
 
+env:
+  frontend-dir: ./frontend
+
 jobs:
   release:
     name: Release
@@ -24,9 +27,11 @@ jobs:
 
       - name: Install dependencies
         run: pnpm install
+        working-directory: ${{ env.frontend-dir }}
 
       - name: Release on NPM
         run: pnpm semantic-release
+        working-directory: ${{ env.frontend-dir }}
         env:
           GH_TOKEN: ${{ secrets.GH_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/test.yml

@@ -13,9 +13,11 @@ on:
 
 env:
   NODE_VERSION: 18
+  frontend-dir: ./frontend
+  backend-dir: ./backend
 
 jobs:
-  lint:
+  lint-frontend:
     name: Lint
     runs-on: [ubuntu-latest]
     timeout-minutes: 5
@@ -39,13 +41,15 @@ jobs:
 
       - name: Install dependencies
         run: pnpm install --no-frozen-lockfile
+        working-directory: ${{ env.frontend-dir }}
 
       - name: Lint ${{ matrix.target }}
         run: pnpm lint:${{ matrix.target }}
+        working-directory: ${{ env.frontend-dir }}
 
-  test:
+  test-frontend:
     name: Tests
-    needs: [lint]
+    needs: [lint-frontend]
     runs-on: [ubuntu-latest]
     timeout-minutes: 10
 
@@ -64,13 +68,37 @@ jobs:
 
       - name: Install dependencies
         run: pnpm install --no-frozen-lockfile
+        working-directory: ${{ env.frontend-dir }}
 
       - name: Run tests
         run: pnpm test
+        working-directory: ${{ env.frontend-dir }}
         env:
           COVERAGE: true
 
       - name: upload coverage report to codecov
         uses: codecov/codecov-action@v3
         with:
           file: ./coverage/lcov.info
+
+  test-backend:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/cache@v3
+        with:
+          path: .venv
+          key: poetry-${{ hashFiles('poetry.lock')}}
+          restore-keys: |
+            peotry-
+      - name: Build the project
+        run: |
+          echo "ENV=dev" > .env
+          docker-compose up -d --build backend
+      - name: Lint the code
+        run: |
+          docker-compose exec -T backend black --check .
+          docker-compose exec -T backend flake8
+          docker-compose exec -T backend python manage.py makemigrations --check --dry-run --no-input
+      - name: Run pytest
+        run: docker-compose exec -T backend pytest --no-cov-on-fail --cov --create-db -vv

.gitignore

@@ -1,37 +1,87 @@
 # See https://help.github.com/ignore-files/ for more about ignoring files.
 
-# compiled output
-/dist
-/tmp
 
-# dependencies
-/node_modules
-/bower_components
+# VSCode
+.vscode/
 
-# misc
-/.sass-cache
-/.eslintcache
-/connect.lock
-/coverage/*
-/libpeerconnection.log
-npm-debug.log*
-testem.log
-*.swp
-*.orig
+# PyCharm
+.idea/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
 
-# vscode
-jsconfig.json
+# Translations
+*.mo
+*.pot
 
-/.vscode/
-/.idea/
+# Django stuff:
+*.log
 
-# ember-try
-/.node_modules.ember-try/
-/bower.json.ember-try
-/npm-shrinkwrap.json.ember-try
-/package.json.ember-try
-/package-lock.json.ember-try
-/yarn.lock.ember-try
+# Sphinx documentation
+docs/_build/
 
-# broccoli-debug
-/DEBUG/
+# PyBuilder
+target/
+
+#Ipython Notebook
+.ipynb_checkpoints
+
+# Pyenv
+.python-version
+
+# Editor swap files
+*.swp
+
+# local .env file
+.env
+
+# pytest
+.pytest_cache
+
+# dependencies
+/node_modules
+/bower_components

CODEOWNERS

@@ -0,0 +1,3 @@
+# Code owners for the Timed backend.
+* @adfinis/dev-backend
+* @adfinis/dev-frontend

CONTRIBUTING.md

@@ -0,0 +1,65 @@
+# Contributing
+
+Contributions to Timed are very welcome! Best have a look at the open [issues](https://github.com/adfinis/timed)
+and open a [GitHub pull request](https://github.com/adfinis/timed/compare). See instructions below how to setup development
+environment. Before writing any code, best discuss your proposed change in a GitHub issue to see if the proposed change makes sense for the project.
+
+## Setup development environment
+
+### Clone
+
+To work on Timed you first need to clone
+
+```bash
+git clone https://github.com/adfinis/timed.git
+cd timed
+```
+
+### Open Shell
+
+Once it is cloned you can easily open a shell in the docker container to
+open a development environment.
+
+```bash
+make shell
+```
+
+### Testing
+
+Once you have shelled in to the docker container as described above
+you can use common python tooling for formatting, linting, testing
+etc.
+
+```bash
+# linting
+poetry run flake8
+# format code
+poetry run black .
+# running tests
+poetry run pytest
+# create migrations
+poetry run python manage.py makemigrations
+```
+
+Writing of code can still happen outside the docker container of course.
+
+### Install new requirements
+
+In case you're adding new requirements you simply need to build the docker container
+again for them to be installed and re-open shell.
+
+```bash
+docker-compose build --pull
+```
+
+### Setup pre commit
+
+Pre commit hooks are an additional option instead of executing checks in your editor of choice.
+
+First create a virtualenv with the tool of your choice before running below commands:
+
+```bash
+pip install pre-commit
+pip install -r requiements-dev.txt -U
+pre-commit install
+```