Merge pull request #75 from ArielMAJ/feat/#49/#66/#73/#74/refactor/tests

Feat/#49/#66/#73/#74/refactor/tests

Author: ArielMAJ

.github/workflows/auto_deploy.yml

@@ -3,7 +3,7 @@ on:
   push:
     branches: ["main"]
     paths:
-      - "vue-front/**"
+      - "frontend/**"
       - ".github/workflows/auto_deploy.yml"
 env:
   VITE_APP_BACKEND_ROOT_ENDPOINT: ${{ vars.VITE_APP_BACKEND_ROOT_ENDPOINT }}
@@ -27,7 +27,7 @@ jobs:
           user_email: "ariel.maj@hotmail.comm"
       - name: deploy to gh-pages
         run: |
-          cd vue-front
+          cd frontend
           bun install
           mkdir tmp
           cd tmp

.python-version

@@ -3,8 +3,8 @@ ifneq ("$(wildcard .env)","")
 	export
 endif
 
-API_DIR = api
-VUE_FRONT_DIR = vue-front
+API_DIR = backend
+VUE_FRONT_DIR = frontend
 
 MAKE_API = $(MAKE) -C $(API_DIR)
 MAKE_VUE_FRONT = $(MAKE) -C $(VUE_FRONT_DIR)
@@ -31,5 +31,5 @@ minor: pre-commit
 	$(MAKE_VUE_FRONT) minor
 
 default-dot-envs:
-	cp ./vue-front/.env.example ./vue-front/.env
-	cp ./api/.env.example ./api/.env
+	cp ./$(VUE_FRONT_DIR)/.env.example ./$(VUE_FRONT_DIR)/.env.local
+	cp ./$(API_DIR)/.env.example ./$(API_DIR)/.env

Makefile

@@ -84,12 +84,12 @@ Everytime you push to the `main` branch, the action will run and deploy the fron
 
 ### Backend
 
-I personally recommend Vercel for the backend, as it is the easiest to set up and use and it's free for personal projects. The [vercel.json](./vercel.json) file is already set up for this, but you're gonna need to change the root directory to your api directory in Vercel:
+I personally recommend Vercel for the backend, as it is the easiest to set up and use and it's free for personal projects. The [vercel.json](./vercel.json) file is already set up for this, but you're gonna need to change the root directory to your backend directory in Vercel:
 ![API root folder image](./docs/images/api-root-folder.png)
 
 Make sure to add any environment variables you create for your API in the Environment Variables section of the Vercel Project Settings.
 
-Obs.: The backend packages are locally managed with `poetry`, but, for simplicity in Vercel deployment, the `requirements.txt` file is present in the folder as well. You can generate the `requirements.txt` file with the command `poetry export -f requirements.txt --output requirements.txt --without-hashes` in the `api` directory. If you use the pre-commit hook, it will automatically generate the `requirements.txt` file for you when you commit.
+Obs.: The backend packages are locally managed with `poetry`, but, for simplicity in Vercel deployment, the `requirements.txt` file is present in the folder as well. You can generate the `requirements.txt` file with the command `poetry export -f requirements.txt --output requirements.txt --without-hashes` in the `backend` directory. If you use the pre-commit hook, it will automatically generate the `requirements.txt` file for you when you commit.
 
 ## Compatibility
 

README.md

@@ -3,21 +3,11 @@ repos:
     rev: "1.7.0"
     hooks:
       - id: poetry-check
-        args: [--directory=api]
+        args: [--directory=backend]
       - id: poetry-lock
-        args: [--directory=api]
+        args: [--directory=backend]
       - id: poetry-install
-        args: [--directory=api]
-      - id: poetry-export
-        args:
-          [
-            --directory=api,
-            --without-hashes,
-            -o,
-            api/requirements.txt,
-            -f,
-            requirements.txt,
-          ]
+        args: [--directory=backend]
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.5.0
     hooks:
@@ -110,5 +100,5 @@ repos:
         name: Export requeriments.txt
         language: system
         pass_filenames: false
-        entry: poetry export --without-hashes -o requirements.txt
+        entry: poetry export --without-hashes -o requirements.txt -f requirements.txt
         files: ^(pyproject\.toml|poetry\.lock)$

api/.python-version

@@ -0,0 +1 @@
+3.9.18