Merge branch 'master' into master

1 files changed, 22 insertions, 14 deletions

diff --git a/README.md b/README.md
index 2e0d9f9..40834e2 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 schema. An example can be found [in the docker folder](./docker/docker-compose.yml).
@@ -85,29 +86,26 @@ After setting up the docker container we recommend you to set up an NGINX revers
 For more information on configuring the Docker image, please read [the ferdi docker documentation](./docker/README.md).
 
 ### 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
@@ -117,19 +115,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`)
@@ -137,7 +139,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