Merge pull request #237 from JJ-8/ctfnote-v3

CTFNote v3

.env.example

@@ -0,0 +1,27 @@
+# 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
+
+# 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=

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

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

.prettierrc

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

.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.