📝 Write doc

src/templates/modules/documentation/Environment.vue

@@ -0,0 +1,165 @@
+<template>
+  <Documentation title="Environment">
+    <p>
+      The environment file contains information confidential to your application such as your token. You must not disclose it under any circumstances.
+      The Discord Factory framework offers you the possibility to choose between 3 types of files :
+    </p>
+    <ul>
+      <li>• Env</li>
+      <li>• Json</li>
+      <li>• Yaml</li>
+    </ul>
+
+    <p>
+      In order to meet the widest variety of needs, each environment file can be extended by adding your own elements such as messages, etc...
+    </p>
+
+    <h2>Why an environment file</h2>
+    <p>
+      The environment file is crucial for several reasons, it contains all the sensitive information of the project and should never be versioned on git.
+      The use of an environment file allows when using container managers (such as docker, kubernetes) to adapt the startup data to the production environment.
+    </p>
+    <p>
+      When you create a new project, you can choose between three types of environment :
+    </p>
+
+    <div>
+      <h3>.env</h3>
+      <CodeHighlight :code="env" />
+    </div>
+    <div>
+      <h3>json</h3>
+      <CodeHighlight :code="json" />
+    </div>
+    <div>
+      <h3>yaml</h3>
+      <CodeHighlight :code="yaml" />
+    </div>
+
+    <h2>Retrieving environment variables</h2>
+    <CodeHighlight :code="getClient" />
+
+  </Documentation>
+</template>
+
+<script setup lang="ts">
+import Documentation from '../../../components/Documentation.vue'
+import CodeHighlight from '../../../components/CodeHighlight.vue'
+import Divider from '../../../components/Divider.vue'
+import LinkExternal from '../../../components/LinkExternal.vue'
+import AlertWarn from '../../../components/AlertWarn.vue'
+import AlertSuccess from '../../../components/AlertSuccess.vue'
+import AlertInfo from '../../../components/AlertInfo.vue'
+const env = `
+APP_PREFIX = "your prefix"
+APP_TOKEN = "your token"
+PRESET_COMMAND_AUTO_REMOVE = true
+
+PARTIAL_MESSAGE = true
+PARTIAL_CHANNEL = true
+PARTIAL_REACTION = true
+
+INTENT_GUILDS = true
+INTENT_GUILD_MEMBERS = true
+INTENT_GUILD_BANS = true
+INTENT_GUILD_EMOJIS_AND_STICKERS = true
+INTENT_GUILD_INTEGRATIONS = true
+INTENT_GUILD_WEBHOOKS = true
+INTENT_GUILD_INVITES = true
+INTENT_GUILD_VOICE_STATES = true
+INTENT_GUILD_PRESENCES = true
+INTENT_GUILD_MESSAGES = true
+INTENT_GUILD_MESSAGE_REACTIONS = true
+INTENT_GUILD_MESSAGE_TYPING = true
+INTENT_DIRECT_MESSAGES = true
+INTENT_DIRECT_MESSAGE_REACTIONS = true
+INTENT_DIRECT_MESSAGE_TYPING = true
+
+MESSAGE_COMMAND_MISSING_PERMISSION = "You're not authorized to execute this command"
+MESSAGE_COMMAND_MISSING_ROLES = "You're not authorized to execute this command"
+MESSAGE_ENVIRONMENT_FILE_PREFIX_MISSING = "The prefix is missing in the environment file."
+MESSAGE_ENVIRONMENT_FILE_TOKEN_MISSING = "The token is missing in the environment file."
+MESSAGE_ENVIRONMENT_FILE_MISSING = "Environment file is missing, please create one."
+`
+
+const json = `
+{
+  "APP_TOKEN": "your prefix",
+  "APP_PREFIX": "your token",
+  "PARTIALS": [
+    "MESSAGE",
+    "CHANNEl",
+    "REACTION"
+  ],
+  "INTENTS": [
+    "GUILDS",
+    "GUILD_MEMBERS",
+    "GUILD_BANS",
+    "GUILD_EMOJIS_AND_STICKERS",
+    "GUILD_INTEGRATIONS",
+    "GUILD_WEBHOOKS",
+    "GUILD_INVITES",
+    "GUILD_VOICE_STATES",
+    "GUILD_PRESENCES",
+    "GUILD_MESSAGES",
+    "GUILD_MESSAGE_REACTIONS",
+    "GUILD_MESSAGE_TYPING",
+    "DIRECT_MESSAGES",
+    "DIRECT_MESSAGE_REACTIONS",
+    "DIRECT_MESSAGE_TYPING",
+  ],
+  "PRESETS": {
+    "COMMAND_AUTO_REMOVE": true
+  },
+  "MESSAGES": {
+    "COMMAND_MISSING_PERMISSION": "You're not authorized to execute this command",
+    "COMMAND_MISSING_ROLES": "You're not authorized to execute this command",
+    "ENVIRONMENT_FILE_PREFIX_MISSING": "The prefix is missing in the environment file.",
+    "ENVIRONMENT_FILE_TOKEN_MISSING": "The token is missing in the environment file.",
+    "ENVIRONMENT_FILE_MISSING": "Environment file is missing, please create one."
+  }
+}
+`
+
+const yaml = `
+APP_TOKEN: your token
+APP_PREFIX: your prefix
+PARTIALS:
+  - MESSAGE
+  - CHANNEL
+  - REACTION
+INTENTS:
+  - GUILDS
+  - GUILD_MEMBERS
+  - GUILD_BANS
+  - GUILD_EMOJIS_AND_STICKERS
+  - GUILD_INTEGRATIONS
+  - GUILD_WEBHOOKS
+  - GUILD_INVITES
+  - GUILD_VOICE_STATES
+  - GUILD_PRESENCES
+  - GUILD_MESSAGES
+  - GUILD_MESSAGE_REACTIONS
+  - GUILD_MESSAGE_TYPING
+  - DIRECT_MESSAGES
+  - DIRECT_MESSAGE_REACTIONS
+  - DIRECT_MESSAGE_TYPING
+PRESETS:
+  COMMAND_AUTO_REMOVE: true
+MESSAGES:
+  COMMAND_MISSING_PERMISSION: You're not authorized to execute this command
+  COMMAND_MISSING_ROLES: You're not authorized to execute this command
+  ENVIRONMENT_FILE_PREFIX_MISSING: The prefix is missing in the environment file.
+  ENVIRONMENT_FILE_TOKEN_MISSING: The token is missing in the environment file.
+  ENVIRONMENT_FILE_MISSING: Environment file is missing, please create one.
+DATABASE:
+  DRIVER: SQLite
+  PATH: database.sql`
+
+const getClient = `
+import { Application } from '@discord-factory/core'
+
+const environment = Application.getEnvironment('APP_PREFIX')
+console.log(environment) // '!'
+`
+</script>

src/templates/modules/documentation/Routes.ts

@@ -1,10 +1,12 @@
 import { RouteRecordRaw } from 'vue-router'
 import GettingStarted from './Getting-started.vue'
 import Starting from './Starting.vue'
+import Environment from './Environment.vue'
 
 const routes: RouteRecordRaw[] = [
   { path: '/documentation/getting-started', component: GettingStarted },
   { path: '/documentation/starting', component: Starting },
+  { path: '/documentation/environment', component: Environment },
 ]
 
 export default routes

src/utils/Navigation.ts

@@ -20,6 +20,7 @@ export const documentation = [
     child: [
       { label: 'Getting starting', href: '/documentation/getting-started', isMenu: false },
       { label: 'Starting', href: '/documentation/starting', isMenu: false },
+      { label: 'Environment', href: '/documentation/environment', isMenu: false },
     ]
   },
 ]