Update to Version 3.1.0

.env.example

@@ -0,0 +1,37 @@
+# Pad
+
+# Secure: we're using HTTPS
+# CMD_PROTOCOL_USESSL=true
+
+# Domain: you need to define this if you wish to enable any options
+# CMD_DOMAIN=example.org:1337
+
+# Content-Security Policy
+# CMD_CSP_ENABLE=true
+
+# Upload on filesystem (instead of imgur)
+# CMD_IMAGE_UPLOAD_TYPE=filesystem
+
+# USE_DISCORD=false
+# DISCORD_BOT_TOKEN=secret_token
+# DISCORD_SERVER_ID=server_id
+# DISCORD_VOICE_CHANNELS=3
+# DISCORD_BOT_NAME=CTFNote
+
+# Enable this if you want users to be able to make accounts through the /register command in discord
+# DISCORD_REGISTRATION_ENABLED=false
+
+# Which role the user should be granted on the ctfnote when creating a account through the bot
+# DISCORD_REGISTRATION_CTFNOTE_ROLE=user_guest
+
+# If you want the bot to verify if a user has a specific role in the discord before allowing them to make a account through
+# the Discord command, set the ID of the role below, else leave this field empty.
+#DISCORD_REGISTRATION_ROLE_ID=discord_id
+
+# Configure timezone and locale
+# TZ=Europe/Paris
+# LC_ALL=en_US.UTF-8
+
+# Can be generated with e.g. pwgen -s 64 1
+# Please provide a string of length 64+ characters
+# SESSION_SECRET=

.gitattributes

@@ -0,0 +1,2 @@
+**/.yarn/releases/** binary
+**/.yarn/plugins/** binary

.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/api"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "npm"
+    directory: "/front"
+    schedule:
+      interval: "weekly"

.github/workflows/build-and-publish.yml

@@ -1,6 +1,7 @@
 name: "Build and publish Docker images to GHCR"
 
 on:
+    workflow_dispatch:
     push:
         branches:
             - "main"

.github/workflows/ci.yml

@@ -0,0 +1,107 @@
+name: Continuous Integration
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+
+  build:
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres:latest
+        env:
+          POSTGRES_PASSWORD: ctfnote
+          POSTGRES_USER: ctfnote
+        ports:
+          - 5432:5432
+
+    strategy:
+      fail-fast: false
+      matrix:
+        node: [20, 19, 18]
+
+    name: Node.js ${{ matrix.node }} build
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Node.js ${{ matrix.node }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node }}
+        cache: "yarn"
+        cache-dependency-path: |
+          api/yarn.lock
+          front/yarn.lock
+
+    - name: Build api
+      working-directory: ./api
+      run: |
+        yarn install --immutable --immutable-cache --check-cache
+        yarn build
+        yarn run pg-validate-migrations ./migrations
+
+    - name: Build frontend
+      working-directory: ./front
+      run: |
+        yarn install --immutable --immutable-cache --check-cache
+        yarn build
+
+    - name: Run database migrations and codegen
+      env:
+        PAD_CREATE_URL: http://hedgedoc:3000/new
+        PAD_SHOW_URL: /
+        DB_DATABASE: ctfnote
+        DB_ADMIN_LOGIN: ctfnote
+        DB_ADMIN_PASSWORD: ctfnote
+        DB_USER_LOGIN: user_postgraphile
+        DB_USER_PASSWORD: secret_password
+        DB_HOST: 127.0.0.1
+        DB_PORT: 5432
+        WEB_PORT: 3000
+      run: |
+        cd ./api
+        # create database tables first, running migrations
+        DB_MIGRATE_ONLY=1 yarn start
+        # then start the api backend server
+        nohup yarn start &
+        cd ../front
+        # and finally validate the generated files are up to date
+        bash ../api/start.sh 127.0.0.1 3000 yarn run graphql-codegen --config codegen.yml --check
+
+  lint:
+    runs-on: ubuntu-latest
+    name: Lint
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Node.js 18
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: "yarn"
+          cache-dependency-path: |
+            api/yarn.lock
+            front/yarn.lock
+
+      - name: Install frontend dependencies
+        working-directory: ./front
+        run: yarn install --immutable --immutable-cache --check-cache
+
+      - name: Lint frontend
+        working-directory: ./front
+        run: |
+          yarn run eslint --ext .js,.ts,.vue,.graphql ./src
+          yarn run prettier --check 'src/**/*.{ts,js,vue,graphql}'
+
+      - name: Install api dependencies
+        working-directory: ./api
+        run: yarn install --immutable --immutable-cache --check-cache
+
+      - name: Lint api
+        working-directory: ./api
+        run: |
+          yarn run eslint --ext .ts ./src
+          yarn run prettier --check 'src/**/*.ts'

.gitignore

@@ -132,16 +132,11 @@ temp/
 # https://yarnpkg.com/advanced/qa#which-files-should-be-gitignored
 
 .yarn/*
-!.yarn/releases
+!.yarn/cache
+!.yarn/patches
 !.yarn/plugins
+!.yarn/releases
 !.yarn/sdks
 !.yarn/versions
 
-# if you are NOT using Zero-installs, then:
-# comment the following lines
-!.yarn/cache
-
-# and uncomment the following lines
-# .pnp.*
-
 # End of https://www.toptal.com/developers/gitignore/api/yarn,node

.prettierrc

@@ -0,0 +1,7 @@
+{
+  "singleQuote": false,
+  "semi": true,
+  "tabWidth": 2,
+  "useTabs": false,
+  "trailingComma": "es5"
+}

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+  "search.exclude": {
+    "**/.yarn": true,
+    "**/node_modules": true
+  }
+}

.yarnrc.yml

@@ -0,0 +1,7 @@
+compressionLevel: mixed
+
+enableGlobalCache: false
+
+nodeLinker: node-modules
+
+yarnPath: .yarn/releases/yarn-4.1.1.cjs

CONTRIBUTING.md

@@ -1,6 +1,8 @@
 # CTFNote - Contribution Guide
 
-When contributing to this repository, please first discuss the change you wish to make via issue with the collaborators of this repository before making a change.
+We have a [Discord server](https://discord.gg/uzTybeYuBg) where we discuss the development and feature of CTFNote.
+
+When contributing to this repository, please first discuss the change you wish to make via issue with the collaborators of this repository before making a change, or have a chat in Discord if you do not want to create a full issue yet.
 
 ## Git process
 
@@ -44,21 +46,22 @@ $ yarn
 This should run the prepare script and install the linting pre-commit hooks:
 
 ```
-[1/4] 🔍  Resolving packages...
-[2/4] 🚚  Fetching packages...
-[3/4] 🔗  Linking dependencies...
-[4/4] 🔨  Building fresh packages...
-$ husky install
-[##] 2/2husky - Git hooks installed
-✨  Done in 0.40s.
+➤ YN0000: · Yarn 4.1.1
+➤ YN0000: ┌ Resolution step
+➤ YN0000: └ Completed
+➤ YN0000: ┌ Fetch step
+➤ YN0000: └ Completed
+➤ YN0000: ┌ Link step
+➤ YN0000: └ Completed
+➤ YN0000: · Done in 0s 103ms
 ```
 
 ### Start the third party containers
 
 ```shell
 $ docker compose \
     -f docker-compose.dev.yml \
-    up -d hedgedoc db adminer
+    up -d hedgedoc db
 ```
 
 ### Start the API
@@ -85,8 +88,7 @@ The following endpoint are exposed and can be used in the developpement environm
 - [GraphiQL](http://localhost:3000/graphiql)
 - [Hedgedoc](http://localhost:3001/)
 - [Quasar APP](http://localhost:8088/)
-- [Adminer](http://localhost:3002/?pgsql=db&username=ctfnote&db=ctfnote)
 
 ## Review
 
-To merge a pull request, two distinct reviews from two different collaborators are required.
+To merge a pull request, a review of a maintainer is required.