feat: moving from express/static to NuxtJS

.gitignore

@@ -1,13 +1,9 @@
-/api/node_modules
-/api/package-lock.json
-/api/.env
-.jsdoc.conf
+node_modules
+*.log*
+.nuxt
+.nitro
+.cache
+.output
 .env
-/api/public/img/brf
-/web-client/node_modules
-/web-client/package-lock.json
-/web-client/.env
-upload
-.markdownlint.json
-.vscode
-gdc-toolbox.code-workspace
+tmp
+docker/

.nvmrc

@@ -0,0 +1 @@
+20

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "semi": false,
+  "singleQuote": true
+}

.sample-env

@@ -0,0 +1,20 @@
+NODE_ENV=production
+
+# Server config
+NITRO_PORT=3000
+
+# Auth0 configuration
+AUTH0_DOMAIN=
+AUTH0_CLIENT_ID=
+AUTH0_API_IDENTIFIER=
+
+# DB config
+MONGO_URL=
+MONGO_DB_NAME=
+MONGO_COLLECTION_NAME=
+
+# Tools
+PBO_MANAGER=
+TEMP_DIR=
+MISSIONS_DIR=
+IMAGES_DIR=

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+	"conventionalCommits.scopes": ["backend", "frontend"]
+}

Dockerfile

@@ -0,0 +1,15 @@
+FROM node:20-alpine as base
+
+ENV NODE_ENV=production
+
+WORKDIR /app
+
+# Install deps
+COPY ./package.json ./yarn.lock ./
+RUN npm ci
+COPY . .
+
+# Build
+RUN npm run build
+
+CMD node .output/server/index.mjs

Makefile

@@ -0,0 +1,31 @@
+help:
+	@egrep "^#" Makefile
+
+prod:
+	npm run build
+	node .output/server/index.mjs
+
+dev:
+	npm run dev
+
+# target: docker-build|db                             - Start docker containers and install deps
+db: docker-build
+docker-build:
+	cp -u .sample-env .env
+	docker compose -f docker-compose.yml -f docker-compose.debug.yml run --rm gdctoolbox sh -c "npm run"
+	echo 'dont forget to update the .env file'
+
+# target: docker-up|du                                - Start docker containers and run dev
+du: docker-up
+docker-up:
+	docker compose -f docker-compose.yml -f docker-compose.debug.yml up -d
+
+# target: prod-docker-up|pdu                          - Start docker containers and run prod
+pdu: prod-docker-up
+prod-docker-up:
+	docker compose -f docker-compose.yml up -d
+
+# target: docker-down|dd                              - Stop docker containers
+dd: docker-down
+docker-down:
+	docker compose down

README.md

@@ -9,7 +9,7 @@ gdc-toolbox is a set of tools for arma gamers, mission makers and community mana
 * [Intented audience](#intented-audience)
 * [Features](#features)
 * [Installation](#installation)
-* [Frenquently asked questions](#frequently-asked-questions)
+* [Frequently asked questions](#frequently-asked-questions)
 * [Tech notes](#tech-notes)
 
 ## Intented audience
@@ -25,7 +25,7 @@ Unless explicitly indicated, those features are provided by gdc-toolbox-api.
 ### Mission checking
 
 Checks the integrity of the mission .pbo file and compliance with certain rules. Each rule can be configured as blocking if it is not satisfied :
-  
+
 * file naming convention : the file name should follow a defined regexp (default: true)
 * pbo integrity : the file should be a real pbo and could be dpbo without any error (default: true)
 * briefing.sqf : a briefing.sqf should exist in the pbo file (default: true)
@@ -99,7 +99,7 @@ Embed API is used, notably for discord embed
 
 ## Installation
 
-### First installation
+### Prerequisites
 
 #### Download and install Mikero tools on your server
 
@@ -111,22 +111,92 @@ At least :
 * DeOgg
 * (maybe) DePbo
 
-#### Download and install node
-
-[node](https://nodejs.org/)
+> [!TODO]
+> add a volume or something into docker-compose.yml
 
 #### Clone git repository
 
+```sh
 git clone <https://github.com/Tanin69/gdc-toolbox>
+```
+
+#### Define environment variables
+
+* Copy `.sample-env` to `.env`
+* Edit your configuration
+
+### Manual
+
+#### Download and install node
+
+[node](https://nodejs.org/)
 
 #### Install modules
 
-In the server directory, run ```npm install```
+```sh
+npm ci
+```
 
-#### Define environment variables
+### Run the server
+
+#### With Node
+
+```sh
+npm run build
+node .output/server/index.mjs
+```
+
+and use Ctrl+C to stop it
+
+#### With PM2
+
+> [!NOTE]
+> [PM2](https://pm2.keymetrics.io) isn't included with GDCToolbox, you may want to install it with :
+>
+> ```sh
+> npm i -g pm2
+> ```
+
+Start :
+
+```sh
+npm run build
+pm2 start ecosystem.config.js
+```
+
+Restart :
+
+```sh
+pm2 restart GDCToolbox
+```
+
+Stop :
+
+```sh
+pm2 stop GDCToolbox
+```
+
+###  Docker
+
+#### Production
+
+```sh
+docker compose up -d
+```
+
+#### Dev
+
+```sh
+nvm use 18
+docker compose -f docker-compose.yml -f docker-compose.debug.yml up -d
+```
+
+or use Makefile commands
 
-* Copy ```.sample-env``` to ```.env```
-* Edit path with your configuration
+```sh
+make db
+make du
+```
 
 ## Frequently Asked Questions
 

README.nuxt.md

@@ -0,0 +1,42 @@
+# Nuxt 3 Minimal Starter
+
+Look at the [nuxt 3 documentation](https://v3.nuxtjs.org) to learn more.
+
+## Setup
+
+Make sure to install the dependencies:
+
+```bash
+# yarn
+yarn install
+
+# npm
+npm install
+
+# pnpm
+pnpm install --shamefully-hoist
+```
+
+## Development Server
+
+Start the development server on http://localhost:3000
+
+```bash
+npm run dev
+```
+
+## Production
+
+Build the application for production:
+
+```bash
+npm run build
+```
+
+Locally preview production build:
+
+```bash
+npm run preview
+```
+
+Checkout the [deployment documentation](https://v3.nuxtjs.org/docs/deployment) for more information.