6 files changed, 187 insertions, 16 deletions

diff --git a/.gitignore b/.gitignore
index 0f1f969..afef829 100644
--- a/.gitignore
+++ b/.gitignore
@@ -19,3 +19,6 @@ recipes/
 resources/announcements/*.json
 !resources/announcements/version.json
 npm-debug.log
+yarn-error.log
+server*.log
+.idea
diff --git a/.npmrc b/.npmrc
new file mode 100644
index 0000000..aafab16
--- /dev/null
+++ b/.npmrc
@@ -0,0 +1,2 @@
+save-exact = true
+engine-strict = true
diff --git a/.nvmrc b/.nvmrc
new file mode 100644
index 0000000..6b17d22
--- /dev/null
+++ b/.nvmrc
@@ -0,0 +1 @@
+14.16.1
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..d276763
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,151 @@
+# Contributing to ferdi-server
+
+:tada: First off, thanks for taking the time and your effort to make Ferdi better! :tada:
+
+## Table of contents
+
+<!-- TOC depthFrom:2 depthTo:2 withLinks:1 updateOnSave:1 orderedList:0 -->
+
+- [Contributing to ferdi-server](#contributing-to-ferdi-server)
+  - [Table of contents](#table-of-contents)
+  - [Code of Conduct](#code-of-conduct)
+  - [What should I know before I get started?](#what-should-i-know-before-i-get-started)
+  - [How Can I Contribute?](#how-can-i-contribute)
+  - [Setting up your Development machine](#setting-up-your-development-machine)
+    - [Install System-level dependencies](#install-system-level-dependencies)
+      - [Node.js, npm, node-gyp](#nodejs-npm-node-gyp)
+      - [Git](#git)
+    - [Clone repository with submodule](#clone-repository-with-submodule)
+    - [Install dependencies](#install-dependencies)
+    - [Styleguide](#styleguide)
+      - [Git Commit Messages format](#git-commit-messages-format)
+      - [Javascript Coding style-checker](#javascript-coding-style-checker)
+
+<!-- /TOC -->
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the [Ferdi Code of Conduct](https://github.com/getferdi/ferdi/blob/develop/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [stefan@adlk.io](mailto:stefan@adlk.io).
+
+## What should I know before I get started?
+
+For the moment, Ferdi's development is a bit slow but all contributions are highly appreciated. [Check this issue for discussion](https://github.com/getferdi/ferdi/issues/956).
+
+## How Can I Contribute?
+
+As a basic rule, before filing issues, feature requests or anything else. Take a look at the issues and check if this has not already been reported by another user. If so, engage in the already existing discussion.
+
+## Setting up your Development machine
+
+### Install System-level dependencies
+
+#### Node.js, npm, node-gyp
+
+Please make sure you are running the exact node version used by the developers/contributors as specified in the [nvmrc file](./.nvmrc).
+
+Currently, these are the combinations of system dependencies that work on an intel-based machines for MacOS/Linux/Windows (building on an ARM-based machine is still a work-in-progress due to node-sass native dependencies)
+
+```bash
+node -v
+v14.16.1
+npm -v
+6.14.12
+node-gyp -v
+v8.0.0
+```
+
+#### Git
+
+The version [2.23.0](https://github.com/git-for-windows/git/releases/tag/v2.23.0.windows.1) for Git is working fine for development. You can then use the console from Git to do the development procedure.
+
+<!-- #### Debian/Ubuntu
+
+```bash
+apt install libx11-dev libxext-dev libxss-dev libxkbfile-dev rpm
+```
+
+#### Fedora
+
+```bash
+dnf install libX11-devel libXext-devel libXScrnSaver-devel libxkbfile-devel rpm
+```
+
+#### Windows
+
+Please make sure you run this command as an administrator:
+
+```bash
+npm i -g windows-build-tools --vs2015
+```
+ -->
+
+### Clone repository with submodule
+
+```bash
+git clone https://github.com/getferdi/server.git
+cd server
+git submodule update --init --recursive
+```
+
+It is important you execute the last command to get the required submodules (recipes, server).
+
+### Install dependencies
+
+- Run the following command to install all dependencies, and link sibling modules with ferdi-server.
+
+```bash
+npm i
+```
+
+- Copy the `.env.example` file into `.env` and change the values to match your system.
+
+```bash
+cp .env.example .env
+```
+
+_Note:_
+
+1. Have env DB_SSL=true only if your database is postgres and it is hosted online on platforms like GCP, AWS, etc
+2. You will have to provide a value for `API_KEY` that is at least 16 characters long.
+
+- If using sqlite for local development, create the database directory (whatever is set to `DATA` in `.env`)
+
+```bash
+mkdir -p data
+```
+
+- Run the database migrations with
+
+  ```bash
+  node ace migration:refresh
+  ```
+
+- To get the full functionality, you will need to have an SMTP server running for local development.
+
+<!-- ### Package recipe repository
+
+Ferdi requires its recipes to be packaged before it can use it. When running Ferdi as a development instance, you'll need to package the local recipes before you can create any services inside Ferdi.
+
+```bash
+cd recipes && npm i && npm run package
+``` -->
+
+### Start development app
+
+  ```bash
+  npm start --dev
+  ```
+
+### Styleguide
+
+#### Git Commit Messages format
+
+- Use the present tense ("Add feature" not "Added feature")
+- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+- Limit the first line to 72 characters or less
+- Reference issues and pull requests liberally after the first line
+- When only changing documentation, include `[ci skip]` in the commit description
+
+#### Javascript Coding style-checker
+
+- Please use `es-lint` and the defined rules to maintain a consistent style
diff --git a/README.md b/README.md
index 098ba16..d6ff0ff 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
 <p align="center">
-    <img src="./logo.png" alt="" width="300"/>  
+    <img src="./logo.png" alt="" width="300"/>
 </p>
 
 # ferdi-server
@@ -16,6 +16,7 @@ Official Server software for the [Ferdi Messaging Browser](https://getferdi.com)
   - [Transferring user data](#transferring-user-data)
   - [Creating and using custom recipes](#creating-and-using-custom-recipes)
     - [Listing custom recipes](#listing-custom-recipes)
+  - [Contributing to ferdi-server's development](#contributing-to-ferdi-servers-development)
   - [License](#license)
 
 ## Why use a custom Ferdi server?
@@ -37,7 +38,7 @@ If you are not interested in doing this you can use our official instance of Fer
 ### with Docker
 The easiest way to set up Ferdi server on your server is with Docker.
 
-The Docker image can be run as is, with the default sqlite database or you can modifying your ENV variables to use an external database (e.g. MySQL, MariaDB, Postgres, etc). 
+The Docker image can be run as is, with the default sqlite database or you can modifying your ENV variables to use an external database (e.g. MySQL, MariaDB, Postgres, etc).
 After setting up the docker container we recommend you to set up an NGINX reverse proxy to access ferdi-server outside of your home network and protect it with an SSL certificate.
 
 1. Pull the Docker image
@@ -47,11 +48,11 @@ After setting up the docker container we recommend you to set up an NGINX revers
     ```
 2. Create a new Docker container with your desired configuration
 
-    ```sh   
+    ```sh
             docker create \
             --name=ferdi-server \
             -e NODE_ENV=development \
-            -e EXTERNAL_DOMAIN=<ferdi-serverdomain> \  
+            -e EXTERNAL_DOMAIN=<ferdi-serverdomain> \
             -e DB_CONNECTION=<database> \
             -e DB_HOST=<yourdbhost> \
             -e DB_PORT=<yourdbport> \
@@ -75,7 +76,7 @@ After setting up the docker container we recommend you to set up an NGINX revers
             -v <path to database>:/app/database \
             -v <path to recipes>:/app/recipes \
             --restart unless-stopped \
-            getferdi/ferdi-server           
+            getferdi/ferdi-server
     ```
 
     Alternatively, you can also use docker-compose v2 schemas
@@ -89,7 +90,7 @@ After setting up the docker container we recommend you to set up an NGINX revers
         container_name: ferdi-server
         environment:
         - NODE_ENV=development
-        - EXTERNAL_DOMAIN=<ferdi-serverdomain>   
+        - EXTERNAL_DOMAIN=<ferdi-serverdomain>
         - DB_CONNECTION=<database>
         - DB_HOST=<yourdbhost>
         - DB_PORT=<yourdbPORT>
@@ -116,34 +117,32 @@ After setting up the docker container we recommend you to set up an NGINX revers
         - <port>:80
         restart: unless-stopped
     ```
+
 3. Optionally, you can now [set up Nginx as a reverse proxy](https://www.digitalocean.com/community/tutorials/how-to-set-up-a-node-js-application-for-production-on-ubuntu-16-04#set-up-nginx-as-a-reverse-proxy-server).
 
 For more information on configuring the Docker image, visit the Docker image repository at <https://github.com/getferdi/server-docker>.
 
 ### Manual setup
+
 1. Clone this repository
 2. Install the [AdonisJS CLI](https://adonisjs.com/)
 3. Copy `.env.example` to `.env` and edit the [configuration](#configuration) to your needs
 4. Have env DB_SSL=true only if your database is postgres and it is hosted online on platforms like GCP, AWS, etc
 5. Run `npm install` to install local dependencies
 6. Run the database migrations with
+
     ```js
-    adonis migration:run
+    node ace migration:run
     ```
+
 7. Start the server with
-    ```js
-    adonis serve --dev
-    ```
-8. If on previous step it does not run the server then run with
+
     ```js
     npm start
     ```
-    or 
-    ```js
-    node server.js
-    ```
 
 ## Configuration
+
 franz-server's configuration is saved inside the `.env` file. Besides AdonisJS's settings, ferdi-server has the following custom settings:
 - `IS_CREATION_ENABLED` (`true` or `false`, default: `true`): Whether to enable the [creation of custom recipes](#creating-and-using-custom-recipes)
 - `IS_REGISTRATION_ENABLED` (`true` or `false`, default: `true`): Whether to enable the creation of new user accounts
@@ -153,19 +152,23 @@ franz-server's configuration is saved inside the `.env` file. Besides AdonisJS's
   - Import Franz accounts
 
 ## Importing your Franz account
+
 ferdi-server allows you to import your full Franz account, including all its settings.
 
 To import your Franz account, open `http://[YOUR FERDI-SERVER]/import` in your browser and login using your Franz account details. ferdi-server will create a new user with the same credentials and copy your Franz settings, services and workspaces.
 
 ## Transferring user data
+
 Please refer to <https://github.com/getferdi/ferdi/wiki/Transferring-data-between-servers>
 
 ## Creating and using custom recipes
+
 ferdi-server allows to extends the Franz recipe catalogue with custom Ferdi recipes.
 
 For documentation on how to create a recipe, please visit [the official guide by Franz](https://github.com/meetfranz/plugins/blob/master/docs/integration.md).
 
 To add your recipe to ferdi-server, open `http://[YOUR FERDI-SERVER]/new` in your browser. You can now define the following settings:
+
 - `Author`: Author who created the recipe
 - `Name`: Name for your new service. Can contain spaces and unicode characters
 - `Service ID`: Unique ID for this recipe. Does not contain spaces or special characters (e.g. `google-drive`)
@@ -173,7 +176,13 @@ To add your recipe to ferdi-server, open `http://[YOUR FERDI-SERVER]/new` in you
 - `Recipe files`: Recipe files that you created using the [Franz recipe creation guide](https://github.com/meetfranz/plugins/blob/master/docs/integration.md). Please do *not* package your files beforehand - upload the raw files (you can drag and drop multiple files). ferdi-server will automatically package and store the recipe in the right format. Please also do not drag and drop or select the whole folder, select the individual files.
 
 ### Listing custom recipes
+
 Inside Ferdi, searching for `ferdi:custom` will list all your custom recipes.
 
+## Contributing to ferdi-server's development
+
+We welcome all contributors. Please read the [contributing guidelines](CONTRIBUTING.md) to setup your development machine and proceed.
+
 ## License
+
 ferdi-server is licensed under the MIT License
diff --git a/package.json b/package.json
index 5b25aac..85a2082 100644
--- a/package.json
+++ b/package.json
@@ -4,10 +4,15 @@
   "adonis-version": "4.1.0",
   "description": "Ferdi server to replace the default Franz server.",
   "main": "index.js",
+  "engines": {
+    "node": "^14.16",
+    "npm": "^6.14",
+    "node-gyp": "^8.0"
+  },
   "scripts": {
     "start": "node server.js",
     "test": "node ace test",
-    "lint": "eslint --fix ./"
+    "lint": "eslint --quiet --fix ./"
   },
   "keywords": [
     "adonisjs",