Docs/219 move backend files into backend folder (#347)

* chore(docs): move backend files into backend folder

* docs(docs): add readme table of contents

Author: gabrielmeleiro1

.dockerignore

@@ -3,9 +3,9 @@ node_modules
 .git
 .gitignore
 .env
-app/.env
+backend/app/.env
 encrypted.env*
-app/data/
+backend/app/data/
 *.md
 dist
 **/dist

.env.example

@@ -7,7 +7,6 @@ COMPOSE_PROJECT_NAME=openml-upload
 # HTTPS origin, for example https://upload.example.com.
 APP_BASE_URL=http://localhost:8000
 CORS_ALLOWED_ORIGINS=http://localhost:8000,http://127.0.0.1:8000
-GITHUB_REDIRECT=http://localhost:8000/login/callback
 
 # Caddy listens on these host ports. For production TLS, set
 # CADDY_SITE_ADDRESS to your domain and HTTP_PORT/HTTPS_PORT to 80/443.
@@ -22,8 +21,8 @@ POSTGRES_PASSWORD=change-me
 JWT_SECRET=change-me
 COOKIE_SECURE=false
 
-# GitHub OAuth App credentials. The OAuth callback URL in GitHub must exactly
-# match GITHUB_REDIRECT.
+# GitHub OAuth App credentials. Configure the OAuth callback URL in GitHub
+# itself, for example http://localhost:8000/login/callback for local Compose.
 GITHUB_CLIENT_ID=
 GITHUB_SECRET=
 GITHUB_OAUTH_SCOPES=read:user,user:email,read:org

.github/CODEOWNERS

@@ -11,10 +11,9 @@
 /.github/ @c0ffeeadd1c7
 
 # Backend
-/app/ @koevoet1221 @gabrielmeleiro1
+/backend/app/ @koevoet1221 @gabrielmeleiro1
 
 # Database
-/alembic/ @koevoet1221
-/app/database/ @koevoet1221
-/app/schemas/ @koevoet1221
-
+/backend/alembic/ @koevoet1221
+/backend/app/database/ @koevoet1221
+/backend/app/schemas/ @koevoet1221

.github/workflows/docker-check.yaml

@@ -43,12 +43,13 @@ jobs:
           python-version: "3.12"
 
       - name: Install backend dependencies
-        run: pip install -r requirements.txt
+        run: pip install -r backend/requirements.txt
 
       - name: Configure local S3 bucket
-        run: python scripts/setup_local_s3.py
+        run: python backend/scripts/setup_local_s3.py
 
       - name: Run backend S3 checks
+        working-directory: backend
         run: |
           pytest \
             app/tests/unit/storage/test_config_and_factory.py \
@@ -72,6 +73,7 @@ jobs:
         uses: docker/build-push-action@v5
         with:
           context: .
+          file: backend/Dockerfile
           push: false
           cache-from: type=gha
           cache-to: type=gha,mode=max

.github/workflows/docker-publish.yaml

@@ -24,6 +24,7 @@ jobs:
         uses: docker/build-push-action@v5
         with:
           context: .
+          file: backend/Dockerfile
           push: false
 
   build-and-push:
@@ -62,6 +63,7 @@ jobs:
         uses: docker/build-push-action@v5
         with:
           context: .
+          file: backend/Dockerfile
           push: true
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}

.github/workflows/pre-commit.yaml

@@ -27,7 +27,7 @@ jobs:
           python-version: "3.14"
 
       - name: Install Python deps
-        run: pip install -r requirements.txt
+        run: pip install -r backend/requirements.txt
 
       - name: Install Pyright
         run: pnpm add -g pyright

.github/workflows/tests.yaml

@@ -46,6 +46,9 @@ jobs:
 
   test-backend:
     runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: backend
     env:
       JWT_SECRET: test-jwt-secret
       COOKIE_SECURE: "false"
@@ -75,7 +78,7 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: backend-test-report
-          path: test.xml
+          path: backend/test.xml
           if-no-files-found: warn
 
   test-e2e:

.gitignore

@@ -12,15 +12,15 @@ test.xml
 frontend/node_modules
 
 #secrets
-app/.env
+backend/app/.env
 .env
 
 
 # Database
 app_dev.db
 .local_uploads/
-app/data/*
-!app/data/.gitkeep
+backend/app/data/*
+!backend/app/data/.gitkeep
 
 # NixOS
 flake.nix