diff --git a/README.md b/README.md
index 46fe919e..4a1c504b 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,45 @@
-# discord-server-opensource
\ No newline at end of file
+# Discord Open Source Server
+This repository contains the HTTP API Server and the WebSocket Gateway Server
+
+## Bug Tracker
+[Project Board](https://github.com/discord-open-source/discord-server/projects/4)
+
+## API
+[Project Board](https://github.com/discord-open-source/discord-server/projects/3)
+
+For the WebSocket we use [ws](https://www.npmjs.com/package/ws) and we'll write our own packet handler for the individual opcodes and events.
+
+## Gateway
+[Project Board](https://github.com/discord-open-source/discord-server/projects/6)
+
+We use [express](https://expressjs.com/) for the HTTP Server and
+[lambert-server](https://www.npmjs.com/package/lambert-server) for route handling and body validation (customized).
+
+## Contribution
+You should be familiar with:
+- [Git](https://git-scm.com/)
+- [NodeJS](https://nodejs.org/)
+- [TypeScript](https://www.typescriptlang.org/)
+- [Lambert-DB](https://www.npmjs.com/package/lambert-db) (easy database abstraction wrapper)
+
+and the technologies we use for Gateway/API
+
+### Getting Started
+Clone the Repository:
+```bash
+git clone https://github.com/discord-open-source/discord-server
+cd discord-server
+```
+#### Install (dev)dependencies:
+```bash
+npm install
+npm install --only=dev
+```
+#### Starting:
+```
+npm start
+```
+#### Debugging:
+**Vscode:**
+The Launch file configuration is in ``./vscode/launch.json``,
+so you can just debug the server by pressing ``F5`` or the ``> Launch Server`` button
diff --git a/locales/de/common.json b/locales/de/common.json
index d5858441..99139d8c 100644
--- a/locales/de/common.json
+++ b/locales/de/common.json
@@ -1,18 +1,18 @@
{
- "field": {
- "BASE_TYPE_REQUIRED": "Dieses Feld ist erforderlich",
- "BASE_TYPE_STRING": "Dieses Feld muss ein Text sein",
- "BASE_TYPE_NUMBER": "Dieses Feld muss eine Nummer sein",
- "BASE_TYPE_BIGINT": "Dieses Feld muss eine Nummer sein",
- "BASE_TYPE_BOOLEAN": "Diese Feld muss true oder false sein",
- "BASE_TYPE_CHOICES": "Dieses Feld muss ({{types}}) sein",
- "BASE_TYPE_CLASS": "Dieses Feld muss ein {{type}} sein",
- "BASE_TYPE_OBJECT": "Dieses Feld muss ein Objekt sein",
- "BASE_TYPE_ARRAY": "Dieses Feld muss ein Array sein",
- "UNKOWN_FIELD": "Unbekannter Wert: {{key}}",
- "BASE_TYPE_CONSTANT": "Dieses Feld muss {{value}} sein",
- "EMAIL_TYPE_INVALID_EMAIL": "Keine gültige E-Mail Adresse",
- "DATE_TYPE_PARSE": "Ungültiges Datum {{date}}, muss dem ISO8601 Standard entsprechen",
- "BASE_TYPE_BAD_LENGTH": "Muss {{length}} Zeichen lang sein"
- }
-}
\ No newline at end of file
+ "field": {
+ "BASE_TYPE_REQUIRED": "Dieses Feld ist erforderlich",
+ "BASE_TYPE_STRING": "Dieses Feld muss einen Text beinhalten",
+ "BASE_TYPE_NUMBER": "Dieses Feld muss eine Nummer beinhalten",
+ "BASE_TYPE_BIGINT": "Dieses Feld muss eine Nummer beinhalten",
+ "BASE_TYPE_BOOLEAN": "Diese Feld muss true oder false sein",
+ "BASE_TYPE_CHOICES": "Dieses Feld muss ({{types}}) sein",
+ "BASE_TYPE_CLASS": "Dieses Feld muss ein {{type}} sein",
+ "BASE_TYPE_OBJECT": "Dieses Feld muss ein Objekt sein",
+ "BASE_TYPE_ARRAY": "Dieses Feld muss ein Array sein",
+ "UNKOWN_FIELD": "Unbekannter Wert: {{key}}",
+ "BASE_TYPE_CONSTANT": "Dieses Feld muss {{value}} sein",
+ "EMAIL_TYPE_INVALID_EMAIL": "Keine gültige E-Mail Adresse",
+ "DATE_TYPE_PARSE": "Ungültiges Datum {{date}}, muss dem ISO8601 Standard entsprechen",
+ "BASE_TYPE_BAD_LENGTH": "Muss {{length}} lang sein"
+ }
+}
diff --git a/package.json b/package.json
index 6f808d29..8a8901c9 100644
--- a/package.json
+++ b/package.json
@@ -4,7 +4,9 @@
"description": "",
"main": "index.js",
"scripts": {
- "test": "echo \"Error: no test specified\" && exit 1"
+ "test": "echo \"Error: no test specified\" && exit 1",
+ "start": "npm run build && node dist/",
+ "build": "tsc -b ."
},
"repository": {
"type": "git",
|