Added v2 structure

Author: app-generator

.github/workflows/main.yml

@@ -0,0 +1,32 @@
+name: JS - Main
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deployment:
+    runs-on: ubuntu-latest
+    timeout-minutes: 120
+    steps:
+      - name: Execute remote SSH commands
+        uses: appleboy/ssh-action@master
+        timeout-minutes: 120
+        with:
+          host: ${{ secrets.HOST }}
+          username: ${{ secrets.USER }}
+          password: ${{ secrets.PASS }}
+          port: ${{ secrets.PORT }}
+          timeout: 120m
+          command_timeout: 120m
+          script: |
+            cd ~/api-server-nestjs
+            git fetch origin main
+            if [ $(git rev-parse HEAD) != $(git rev-parse @{u}) ]; then
+              git pull origin main
+              export DOCKER_BUILDKIT=1
+              docker compose up -d --build --no-deps --pull always && docker system prune -af
+            else
+              echo "No changes detected, skipping deployment."
+            fi

CHANGELOG.md

@@ -0,0 +1,13 @@
+# Change Log
+
+## [0.0.2] 2024-12-15
+### Changes
+
+- Added Backend
+- Added React UI (Mantis Design)
+
+## [0.0.1] 2024-11-11
+### Changes
+
+- REPO Created
+- Specs Added (RM)

README.md

@@ -0,0 +1,162 @@
+# Django API Server
+
+Open-Source API server powered by [Django](https://app-generator.dev/docs/technologies/django/index.html), a progressive Node.js framework for building efficient, reliable, and scalable server-side applications.
+
+> Status: **Work in progress**
+
+- 👉 [Django API Server](#) - **Complete Documentation**
+- 👉 [Get Support](https://app-generator.dev/ticket/create/) via Email and Discord
+
+<br />
+
+## Features  
+
+- **Best Practices**: Follows industry-standard best practices for building robust APIs.
+- **Backend**: Built with Django, a powerful and scalable Node.js framework.
+- **UI**: 
+  - React Mantis (optional frontend integration).
+
+<br />
+
+## Backend API
+
+- **Simple, modular & intuitive structure**: Easy to understand and extend.
+- **Toolchain**:
+  - Usable with the latest Node.js LTS versions:
+    - v22.x
+    - v21.x
+    - v20.x
+  - Package Managers: 
+    - PNPM, 
+    - Yarn, 
+    - Npm  
+- **Authentication**: Auth0 for GitHub integration.
+  - GitHub email pulled during OAuth SignIN.
+  - Optional: Email validation.
+- **Roles**: Admin, Users.
+- **ORM**: Prisma for database management.
+- **User Profiles**:
+  - ROLE: Default user.
+  - Fields: Name, surname, bio, country, address, job.
+- **API Features**:
+  - Search, Pagination.
+  - Public Access: GET by ID, get all.
+  - Private access (requires token):
+    - Create, Update, Delete.
+- **Admin**:
+  - Can search or mutate any user.
+- **Users**:
+  - Can view and mutate only their own information.
+
+## Start with Docker
+
+@Todo
+
+## Start Django Backend
+
+> Edit Environment
+
+Add a `.env` file to your project root directory and populate as follows:
+
+```env
+AUTH0_DOMAIN=YOUR_AUTH0_DOMAIN
+AUTH0_CLIENT_ID=YOUR_AUTH0_CLIENT_ID
+AUTH0_CLIENT_SECRET=YOUR_AUTH0_CLIENT_SECRET
+
+JWT_SECRET=YOUR_JWT_SECRET
+
+DATABASE_URL=YOUR_DATABASE_URL
+```
+
+Here's how to get the required Auth0 details. You need to register a client (application) in your Auth0 dashboard.
+
+Follow these steps to register a client with Auth0:
+
+1. Open the [Auth0 Applications](https://manage.auth0.com/?_gl=1*1a4zekg*_ga*Mjg3MzE5NzcyLjE3MzcwMjU4MzA.*_ga_QKMSDV5369*MTczNzIwMTkzNy45LjEuMTczNzIwMTk1Ni40MS4wLjA.#/applications) section of the Auth0 Dashboard.
+2. Click on the **Create Application** button.
+3. Provide a **Name**, such as "GitHub Auth".
+4. Choose `Single Page Web Applications` as the application type.
+5. Click on the **Create** button.
+6. Finally, note down your `Domain`, `Client ID`, and `Client Secret` and add them to your `.env` file. Click the settings tab if you do not see them.
+
+Choose a random string of letters and numbers for your `JWT_SECRET` and populate the `DATABASE_URL` with your database connection string.
+
+> Install Dependencies
+
+Run the following to install dependencies:
+
+```bash
+npm install
+```
+
+OR
+
+```bash
+yarn
+```
+
+> Set Up Prisma
+
+1. Run the following command to generate the Prisma client and apply migrations:
+
+```bash
+npx prisma generate
+npx prisma migrate dev --name init
+```
+
+2. If you need to seed your database, you can add a `seed` script in the `prisma/seed.ts` file and run:
+
+```bash
+npx prisma db seed
+```
+
+> Run Your Server
+
+Start the Django server with:
+
+```bash
+npm run start:dev
+```
+
+OR
+
+```bash
+yarn start:dev
+```
+
+## Compile [React UI](https://github.com/codedthemes/mantis-free-react-admin-template)
+
+> Edit Environment
+
+Add your server base URL to your environment variables as follows:
+
+```env
+VITE_APP_PUBLIC_URL=<YOUR_SERVER_URL>
+```
+
+> Install Dependencies
+
+```bash
+npm install
+```
+
+OR
+
+```bash
+yarn
+```
+
+> Start the React UI
+
+```bash
+npm run dev
+```
+
+OR
+
+```bash
+yarn dev
+```
+
+---
+Django API Starter provided by [App Generator](https://app-generator.dev/) - Open-source service for developers and companies.

backend/.gitkeep

@@ -0,0 +1,45 @@
+services:
+  backend:
+    build: ./backend
+    container_name: backend
+    ports:
+      - "3000:3000"
+    env_file:
+      - ./backend/.env
+    command: >
+      sh -c "
+        npx prisma generate
+        npx prisma migrate deploy
+        yarn start:dev
+      "
+    networks:
+      - app-network
+
+  frontend:
+    build: ./ui-mantis
+    container_name: frontend
+    ports:
+      - "4000:4000"
+    env_file:
+      - ./ui-mantis/.env
+    networks:
+      - app-network
+    depends_on:
+      - backend
+
+  # nginx:
+  #   image: nginx:alpine
+  #   container_name: nginx
+  #   ports:
+  #     - "80:80"
+  #   volumes:
+  #     - ./nginx/nginx.conf:/etc/nginx/nginx.conf
+  #   depends_on:
+  #     - backend
+  #     - frontend
+  #   networks:
+  #     - app-network
+
+networks:
+  app-network:
+    driver: bridge

docker-compose.yml

@@ -0,0 +1,31 @@
+events {}
+
+http {
+    upstream backend {
+        server backend:3000;
+    }
+
+    upstream frontend {
+        server frontend:4000;
+    }
+
+    server {
+        listen 80;
+
+        location /api/ {
+            proxy_pass http://backend;
+            proxy_set_header Host $host;
+            proxy_set_header X-Real-IP $remote_addr;
+            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+            proxy_set_header X-Forwarded-Proto $scheme;
+        }
+
+        location / {
+            proxy_pass http://frontend;
+            proxy_set_header Host $host;
+            proxy_set_header X-Real-IP $remote_addr;
+            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+            proxy_set_header X-Forwarded-Proto $scheme;
+        }
+    }
+}

nginx/nginx.conf

@@ -0,0 +1,6 @@
+VITE_APP_VERSION=v1.3.0
+GENERATE_SOURCEMAP=false
+
+## Backend API URL
+VITE_APP_PUBLIC_URL = http://0.0.0.0:4000
+VITE_APP_BASE_NAME = /free

ui-mantis/.env

@@ -0,0 +1,89 @@
+{
+  "root": true,
+  "env": {
+    "browser": true,
+    "es2021": true
+  },
+  "extends": [
+    "prettier",
+    "plugin:react/jsx-runtime",
+    "plugin:jsx-a11y/recommended",
+    "plugin:react-hooks/recommended",
+    "eslint:recommended",
+    "plugin:react/recommended"
+  ],
+  "settings": {
+    "react": {
+      "createClass": "createReactClass", // Regex for Component Factory to use,
+      // default to "createReactClass"
+      "pragma": "React", // Pragma to use, default to "React"
+      "fragment": "Fragment", // Fragment to use (may be a property of <pragma>), default to "Fragment"
+      "version": "detect", // React version. "detect" automatically picks the version you have installed.
+      // You can also use `16.0`, `16.3`, etc, if you want to override the detected value.
+      // It will default to "latest" and warn if missing, and to "detect" in the future
+      "flowVersion": "0.53" // Flow version
+    },
+    "import/resolver": {
+      "node": {
+        "moduleDirectory": ["node_modules", "src/"]
+      }
+    }
+  },
+  "parser": "@babel/eslint-parser",
+  "parserOptions": {
+    "ecmaFeatures": {
+      "experimentalObjectRestSpread": true,
+      "impliedStrict": true,
+      "jsx": true
+    },
+    "ecmaVersion": 12
+  },
+  "plugins": ["prettier", "react", "react-hooks"],
+  "rules": {
+    "react/jsx-uses-react": "error",
+    "react/jsx-uses-vars": "error",
+    "react/react-in-jsx-scope": "off",
+    "no-undef": "off",
+    "react/display-name": "off",
+    "react/jsx-filename-extension": "off",
+    "no-param-reassign": "off",
+    "react/prop-types": 1,
+    "react/require-default-props": "off",
+    "react/no-array-index-key": "off",
+    "react/jsx-props-no-spreading": "off",
+    "react/forbid-prop-types": "off",
+    "import/order": "off",
+    "import/no-cycle": "off",
+    "no-console": "off",
+    "jsx-a11y/anchor-is-valid": "off",
+    "prefer-destructuring": "off",
+    "no-shadow": "off",
+    "import/no-named-as-default": "off",
+    "import/no-extraneous-dependencies": "off",
+    "jsx-a11y/no-autofocus": "off",
+    "no-restricted-imports": [
+      "error",
+      {
+        "patterns": ["@mui/*/*/*", "!@mui/material/test-utils/*"]
+      }
+    ],
+    "no-unused-vars": [
+      "error",
+      {
+        "ignoreRestSiblings": false
+      }
+    ],
+    "prettier/prettier": [
+      "warn",
+      {
+        "bracketSpacing": true,
+        "printWidth": 140,
+        "singleQuote": true,
+        "trailingComma": "none",
+        "tabWidth": 2,
+        "useTabs": false,
+        "endOfLine": "auto"
+      }
+    ]
+  }
+}