chore: rename backend to api

kartAI · Nov 28, 2024 · 2a45f43 · 2a45f43
1 parent d11e94b
commit 2a45f43
Show file tree

Hide file tree

Showing 43 changed files with 10 additions and 11 deletions.
diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml
@@ -35,10 +35,10 @@ jobs:
         id: git_sha
         run: echo "GIT_SHA=$(git rev-parse --short $GITHUB_SHA)" >> $GITHUB_ENV
 
-      - name: Build and Push Docker Backend Image
+      - name: Build and Push Docker AI API Image
         run: |
-          docker build -t ghcr.io/kartai/ntnu-kpro-ai-assistant-backend:${{ env.GIT_SHA }} ./backend
-          docker push ghcr.io/kartai/ntnu-kpro-ai-assistant-backend:${{ env.GIT_SHA }}
+          docker build -t ghcr.io/kartai/ntnu-kpro-ai-assistant-api:${{ env.GIT_SHA }} ./api
+          docker push ghcr.io/kartai/ntnu-kpro-ai-assistant-api:${{ env.GIT_SHA }}
 
       - name: Build and Push Docker Webapp Image
         run: |

diff --git a/README.md b/README.md
@@ -99,17 +99,17 @@ Before you start, make sure the following tools are installed on your system:
 
 ## Setup
 
-Start by going into the `/webapp` folder, making a copy of the `.env.example` file and renaming it to `.env`. This file contains the environment variables that the application needs to run. Open the `.env` file and update the environment variables according to your local or production setup.
+Start by going into the `/webapp` and `/api` folder, making a copy of the `.env.example` file and renaming it to `.env`. This file contains the environment variables that the application needs to run. Open the `.env` file and update the environment variables according to your local or production setup.
 
 ## Usage
 
 To run the project, you can use the following commands:
 
 ```bash
-docker compose --env-file ./webapp/.env  --env-file ./backend/.env up --build -d
+docker compose --env-file ./webapp/.env  --env-file ./api/.env up --build -d
 ```
 
-This command will build the Docker images (if necessary) and run the containers in the background. You can access the clientside code at [http://localhost:3000](http://localhost:3000) and the API at [http://localhost:8000](http://localhost:8000).
+This command will build the Docker images (if necessary) and run the containers in the background. You can access the client side code at [http://localhost:3000](http://localhost:3000) and the API at [http://localhost:8000](http://localhost:8000).
 The Swagger documentation for the API is available at [http://localhost:8000/docs](http://localhost:8000/docs).
 
 To stop the containers, you can use the following command:

diff --git a/backend/.env.example → api/.env.example b/backend/.env.example → api/.env.example
diff --git a/backend/.flake8 → api/.flake8 b/backend/.flake8 → api/.flake8
diff --git a/backend/.mypy.ini → api/.mypy.ini b/backend/.mypy.ini → api/.mypy.ini
diff --git a/backend/Dockerfile → api/Dockerfile b/backend/Dockerfile → api/Dockerfile
diff --git a/backend/law_context.txt → api/law_context.txt b/backend/law_context.txt → api/law_context.txt
diff --git a/backend/requirements.txt → api/requirements.txt b/backend/requirements.txt → api/requirements.txt
diff --git a/backend/src/__init__.py → api/src/__init__.py b/backend/src/__init__.py → api/src/__init__.py
diff --git a/backend/src/configuration.py → api/src/configuration.py b/backend/src/configuration.py → api/src/configuration.py
diff --git a/backend/src/main.py → api/src/main.py b/backend/src/main.py → api/src/main.py
diff --git a/backend/src/services/__init__.py → api/src/services/__init__.py b/backend/src/services/__init__.py → api/src/services/__init__.py
diff --git a/backend/src/services/agent.py → api/src/services/agent.py b/backend/src/services/agent.py → api/src/services/agent.py
diff --git a/...src/services/agent_parts/checklist_api.py → ...src/services/agent_parts/checklist_api.py b/...src/services/agent_parts/checklist_api.py → ...src/services/agent_parts/checklist_api.py
diff --git a/backend/src/services/agent_parts/crag.py → api/src/services/agent_parts/crag.py b/backend/src/services/agent_parts/crag.py → api/src/services/agent_parts/crag.py
diff --git a/...end/src/services/agent_parts/generator.py → api/src/services/agent_parts/generator.py b/...end/src/services/agent_parts/generator.py → api/src/services/agent_parts/generator.py
diff --git a/backend/src/services/external_ai_models.py → api/src/services/external_ai_models.py b/backend/src/services/external_ai_models.py → api/src/services/external_ai_models.py
diff --git a/backend/src/services/reader.py → api/src/services/reader.py b/backend/src/services/reader.py → api/src/services/reader.py
diff --git a/backend/src/services/readers/__init__.py → api/src/services/readers/__init__.py b/backend/src/services/readers/__init__.py → api/src/services/readers/__init__.py
diff --git a/...rc/services/readers/digital_pdf_reader.py → ...rc/services/readers/digital_pdf_reader.py b/...rc/services/readers/digital_pdf_reader.py → ...rc/services/readers/digital_pdf_reader.py
diff --git a/backend/src/services/readers/factory.py → api/src/services/readers/factory.py b/backend/src/services/readers/factory.py → api/src/services/readers/factory.py
diff --git a/backend/src/services/readers/ocr_reader.py → api/src/services/readers/ocr_reader.py b/backend/src/services/readers/ocr_reader.py → api/src/services/readers/ocr_reader.py
diff --git a/backend/src/services/readers/xml_reader.py → api/src/services/readers/xml_reader.py b/backend/src/services/readers/xml_reader.py → api/src/services/readers/xml_reader.py
diff --git a/backend/src/services/tools/visulization.py → api/src/services/tools/visulization.py b/backend/src/services/tools/visulization.py → api/src/services/tools/visulization.py
diff --git a/backend/src/types.py → api/src/types.py b/backend/src/types.py → api/src/types.py
diff --git a/backend/tests/__init__.py → api/tests/__init__.py b/backend/tests/__init__.py → api/tests/__init__.py
diff --git a/backend/tests/agent_test.py → api/tests/agent_test.py b/backend/tests/agent_test.py → api/tests/agent_test.py
diff --git a/backend/tests/files/byggesak_1.xml → api/tests/files/byggesak_1.xml b/backend/tests/files/byggesak_1.xml → api/tests/files/byggesak_1.xml
diff --git a/backend/tests/files/byggesak_2.xml → api/tests/files/byggesak_2.xml b/backend/tests/files/byggesak_2.xml → api/tests/files/byggesak_2.xml
diff --git a/backend/tests/files/byggesak_3.xml → api/tests/files/byggesak_3.xml b/backend/tests/files/byggesak_3.xml → api/tests/files/byggesak_3.xml
diff --git a/backend/tests/files/byggesak_4.xml → api/tests/files/byggesak_4.xml b/backend/tests/files/byggesak_4.xml → api/tests/files/byggesak_4.xml
diff --git a/backend/tests/files/corrupted.pdf → api/tests/files/corrupted.pdf b/backend/tests/files/corrupted.pdf → api/tests/files/corrupted.pdf
diff --git a/backend/tests/files/empty.pdf → api/tests/files/empty.pdf b/backend/tests/files/empty.pdf → api/tests/files/empty.pdf
diff --git a/backend/tests/files/invalid.txt → api/tests/files/invalid.txt b/backend/tests/files/invalid.txt → api/tests/files/invalid.txt
diff --git a/backend/tests/files/large.pdf → api/tests/files/large.pdf b/backend/tests/files/large.pdf → api/tests/files/large.pdf
diff --git a/backend/tests/files/malware.exe → api/tests/files/malware.exe b/backend/tests/files/malware.exe → api/tests/files/malware.exe
diff --git a/backend/tests/files/ocr_test_image_1.jpg → api/tests/files/ocr_test_image_1.jpg b/backend/tests/files/ocr_test_image_1.jpg → api/tests/files/ocr_test_image_1.jpg
diff --git a/backend/tests/files/ocr_test_image_2.png → api/tests/files/ocr_test_image_2.png b/backend/tests/files/ocr_test_image_2.png → api/tests/files/ocr_test_image_2.png
diff --git a/backend/tests/files/structured.pdf → api/tests/files/structured.pdf b/backend/tests/files/structured.pdf → api/tests/files/structured.pdf
diff --git a/backend/tests/files/unstructured.pdf → api/tests/files/unstructured.pdf b/backend/tests/files/unstructured.pdf → api/tests/files/unstructured.pdf
diff --git a/backend/tests/integrations_test.py → api/tests/integrations_test.py b/backend/tests/integrations_test.py → api/tests/integrations_test.py
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -21,12 +21,12 @@ services:
   api:
     platform: "linux/amd64"
     build:
-      context: ./backend
+      context: ./api
       dockerfile: Dockerfile
     ports:
       - "8000:8000"
     volumes:
-      - ./backend:/code
+      - ./api:/code
     environment:
       - AZURE_OPENAI_API_KEY=${AZURE_OPENAI_API_KEY}
       - AZURE_OPENAI_API_BASE=${AZURE_OPENAI_API_BASE}

diff --git a/scripts/pre-commit.sh b/scripts/pre-commit.sh
@@ -1,9 +1,8 @@
 #!/bin/sh
 # Run linter on staged JavaScript, TypeScript files
-cd webapp
-npm run lint --fix
 
-cd backend
+
+cd api
 black .
 
 # mypy