Development 1.1

.dockerignore

@@ -0,0 +1 @@
+**/node_modules

.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -0,0 +1,23 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ""
+labels: ""
+assignees: ""
+---
+
+### Search first
+
+Search for similar issues first, if not complete the following template
+
+### Description
+
+A clear description of the bug
+
+### Steps to reproduce
+
+List of steps to reproduce the problem if it's a bug
+
+### Logs/Alerts
+
+Logs/Alerts if available

.github/ISSUE_TEMPLATE/FEATURE_REQUEST.MD

@@ -0,0 +1,23 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ""
+labels: ""
+assignees: ""
+---
+
+### Search first
+
+Search for similar issues first, if you got no results, complete the following template
+
+### Description
+
+A clear description of the new feature
+
+### Implementation
+
+If you've a specific approach to discuss, describe it here clearly.
+
+### More
+
+Write more details here if needed about the feature

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,19 @@
+### Description
+
+Describe the changes introduced by this PR and what does it affect
+
+### Changes
+
+List of changes this PR includes
+
+### Related Issues
+
+List of related issues
+
+### Checklist
+
+- [ ] Tests included
+- [ ] Build pass
+- [ ] Documentation
+- [ ] Code format and docstrings
+- [ ] Screenshots/Video attached (needed for UI changes)

.github/workflows/build.yml

@@ -1,40 +1,35 @@
-# Test if working.
-name: Build and push a docker image and a flist.
+name: Build
 
 on:
   push:
-    branches: [main, development]
+    branches: 
+      [development_1.1, development_1.1_*]
 
 jobs:
-  build:
+  run-linters:
+    name: Run linters
     runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - name: Login to DockerHub
-        uses: docker/login-action@v2
-        with:
-          username: ${{ secrets.DOCKER_USERNAME }}
-          password: ${{ secrets.DOCKER_PASSWORD }}
 
-      - name: Build and push server image
-        uses: docker/build-push-action@v3
-        with:
-          push: true
-          tags: ${{ secrets.DOCKER_USERNAME }}/cshr_server:latest
-          file: "./Dockerfile"
+    strategy:
+      matrix:
+        node-version: [18.x]
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
 
-      - name: Build and push client image
-        uses: docker/build-push-action@v3
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
         with:
-          push: true
-          tags: ${{ secrets.DOCKER_USERNAME }}/cshr_client:latest
-          file: "./client/Dockerfile"
-          context: ./client
+          node-version: ${{ matrix.node-version }}
 
-      - name: build and push server flist
+      - name: Install Dependencies
         run: |
-          curl -f -X POST  -H "Authorization: bearer ${{ secrets.FLIST_TOKEN }}" https://hub.grid.tf/api/flist/me/docker -F 'image=${{ secrets.DOCKER_USERNAME }}/cshr_server:latest'
+          cd client
+          npm install -g pnpm
+          pnpm install
 
-      - name: build and push client flist
+      - name: Build
         run: |
-          curl -f -X POST  -H "Authorization: bearer ${{ secrets.FLIST_TOKEN }}" https://hub.grid.tf/api/flist/me/docker -F 'image=${{ secrets.DOCKER_USERNAME }}/cshr_client:latest'
+          cd client
+          pnpm build

.github/workflows/lint.yml

@@ -1,28 +1,36 @@
-name: Lint
+name: Lint and Build
 
 on:
   push:
-    branches:
-      - '**' 
+    branches: 
+      [development_1.1, development_1.1_*]
 
 jobs:
   run-linters:
     name: Run linters
     runs-on: ubuntu-latest
 
+    strategy:
+      matrix:
+        node-version: [18.x]
+
     steps:
-      - name: Check out Git repository
+      - name: Checkout Repository
         uses: actions/checkout@v2
 
-      - name: Set up Python
-        uses: actions/setup-python@v1
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
         with:
-          python-version: 3.8
+          node-version: ${{ matrix.node-version }}
 
-      - name: Install Python dependencies
-        run: pip install flake8
+      - name: Install Dependencies
+        run: |
+          cd client
+          npm install -g pnpm
+          pnpm install
 
-      - name: Run linters
-        uses: wearerequired/lint-action@v2
-        with:
-          flake8: true
+      - name: Lint and Format
+        run: |
+          cd client
+          pnpm lint
+          pnpm format

.github/workflows/test.yml

@@ -2,8 +2,7 @@ name: Test
 
 on:
   push:
-    branches: 
-    - '**' 
+    branches: [main, development]
 jobs:
   test:
     runs-on: ubuntu-latest

Makefile

@@ -1,32 +1,68 @@
 
 CMD:=poetry run
 client:=cd client
+server:=cd server
 terraform:=cd terraform
 
+help:
+	@echo "\n- Docker: To build and run a specific service, you can do that by executing 'make docker-up service=<service_name>'."
+	@echo "\n- To run a the backend project, you can do that by executing 'make runserver'."
+	@echo "\n- To run a the backend client, you can do that by executing 'make runclient'."
+
 docker-up:
-	docker-compose up --build -d
+ifeq ($(service), frontend)
+	docker compose -f ./docker/docker-compose.yml --env-file=./config/.env up frontend --build -d
+else ifeq ($(service), backend)
+	docker compose -f ./docker/docker-compose.yml --env-file=./config/.env up backend --build -d
+else ifeq ($(service), postgres)
+	docker compose -f ./docker/docker-compose.yml --env-file=./config/.env up postgres --build -d
+else
+	docker compose -f ./docker/docker-compose.yml --env-file=./config/.env up --build -d
+endif
+
+docker-down:
+ifeq ($(service), frontend)
+	docker compose -f ./docker/docker-compose.yml --env-file=./config/.env down frontend
+else ifeq ($(service), backend)
+	docker compose -f ./docker/docker-compose.yml --env-file=./config/.env down backend
+else ifeq ($(service), postgres)
+	docker compose -f ./docker/docker-compose.yml --env-file=./config/.env down postgres
+else
+	docker compose -f ./docker/docker-compose.yml --env-file=./config/.env down
+endif
+
+docker-logs:
+ifeq ($(service), frontend)
+	docker compose -f ./docker/docker-compose.yml --env-file=./config/.env logs -f frontend
+else ifeq ($(service), backend)
+	docker compose -f ./docker/docker-compose.yml --env-file=./config/.env logs -f backend
+else ifeq ($(service), postgres)
+	docker compose -f ./docker/docker-compose.yml --env-file=./config/.env logs -f postgres
+else
+	docker compose -f ./docker/docker-compose.yml --env-file=./config/.env logs -f
+endif
+
 install:
-	curl -sSL https://install.python-poetry.org | python3 -
-	poetry install
-	poetry check
-	cd client && npm i && cd ..
+	$(server) && poetry install
+	$(server) && poetry check
+	$(client) && pnpm i
 runserver:
-	$(CMD) python3 manage.py runserver
+	$(server) && $(CMD) python3 manage.py runserver
 runclient:
-	$(client) && npm i && npm run dev
+	$(client) && pnpm i && pnpm dev
 test:
-	$(CMD) python3 manage.py test
+	$(server) && $(CMD) python3 manage.py test
 lint:
-	$(CMD) black server/  --exclude=__init__.py
-	$(CMD) flake8 server/  --exclude=__init__.py
-	$(client) && npm run lint
+	$(server) && $(CMD) black .  --exclude=__init__.py
+	$(server) && $(CMD) flake8 .  --exclude=__init__.py
+	$(client) && pnpm lint
 migrate:
-	$(CMD) python3 manage.py makemigrations
-	$(CMD) python3 manage.py migrate
+	$(server) && $(CMD) python3 manage.py makemigrations
+	$(server) && $(CMD) python3 manage.py migrate
 user:
-	$(CMD) python3 manage.py createsuperuser
+	$(server) && $(CMD) python3 manage.py createsuperuser
 data:
-	$(CMD) python3 manage.py create locations users
+	$(server) && $(CMD) python3 manage.py create locations users
 deploy:
 	$(terraform) && terraform init && terraform apply -auto-approve
 destroy:

README.md

@@ -53,6 +53,33 @@ When in development mode, use the following Makefile commands:
 - **Server:** Implemented using Django.
 - **Notification Service:** Requires a running Redis server for notification functionality.
 
+## Installation Process
+
+To facilitate the installation process, this project utilizes the `poetry` package manager for `Python` and `pnpm` for `Node.js`. Follow the steps outlined below for a seamless installation:
+
+1. Install Poetry:
+Execute the following command to install Poetry for Python:
+
+```sh
+curl -sSL https://install.python-poetry.org | python3 -
+```
+
+2. Install Pnpm:
+To install `pnpm` globally for Node.js, run the following command:
+
+```sh
+npm i -g pnpm
+```
+
+After installing these packages you can now install the required packages by executing:
+3. Install project Packages
+
+```sh
+make install
+```
+
+By following these steps, you ensure the proper setup of the required package managers for this project.
+
 ## Project Configuration
 
 After executing
@@ -62,3 +89,40 @@ make install && make migrate
 ```
 
 Please refer to [.env.template](./config/.env.template) for all required values. Ensure all values are populated in the `.env` file within the [config](./config/) directory.
+
+## Runing the project using Docker and Docker Compose
+
+To run the full project with all instances, follow these steps:
+
+1. Set Environment Variables
+
+Create a `.env` file beside the [config](./config/) directory and set the necessary environment variables. Refer to the previous section for sample environment variable configurations.
+
+2. Execute Docker Compose
+
+Run the following command to start the Docker containers and please make sure that you are on the root of the project:
+
+```sh
+# --> To run all services
+
+└─(✹)──> docker compose -f ./docker/docker-compose.yml --env-file=./config/.env up --build -d 
+
+# --> To stop all services
+└─(✹)──> docker compose -f ./docker/docker-compose.yml --env-file=./config/.env down 
+
+```
+
+Also, you can excute the command using Make:
+
+- make docker-up **To run all services**
+- make docker-down **To stop all services**
+
+After executing the command, you should see a confirmation similar to the following:
+
+3. Verify Successful Deployment
+
+This indicates that the Docker containers are being created and the services are starting up.
+
+- ![docker-compose-deployments](docs/images/docker-compose-deployments.png)
+
+You can also take a look at [configuration.md](docs/configuration.md)

client/.env

@@ -0,0 +1,10 @@
+# Client Related
+VITE_TITLE="Codescalers HR management system"
+VITE_FAVICON="https://placehold.co/32/steelblue/white?text=CS"
+VITE_LOGO="https://placehold.co/128/steelblue/white?text=CS"
+
+# Server Related
+SERVER_DOMAIN_NAME_API="http://127.0.0.1:8000/api"
+
+# Development Related
+VITE_DEBUG=false

client/.eslintrc.cjs

@@ -0,0 +1,15 @@
+/* eslint-env node */
+require('@rushstack/eslint-patch/modern-module-resolution')
+
+module.exports = {
+  root: true,
+  'extends': [
+    'plugin:vue/vue3-essential',
+    'eslint:recommended',
+    '@vue/eslint-config-typescript',
+    '@vue/eslint-config-prettier/skip-formatting'
+  ],
+  parserOptions: {
+    ecmaVersion: 'latest'
+  }
+}