Update README.md to contain a getting started with development guide

Author: Rotti2

README.md

@@ -33,9 +33,12 @@ Introducing Singularity: Your browser's karaoke stage! Gather your friends for a
 - [Installation](#Installation)
   - [Docker](#docker-)
 - [Upload Songs](#upload-songs)
+- [Local Development](#getting-started-with-local-development)
+  - [Database Migrations](#database-migrations)
 - [Credits](#credits)
 
 
+
 ## Installation
 ### Docker 🐋
 1. Install [Docker](https://www.docker.com/)
@@ -100,6 +103,85 @@ You can upload songs to Singularity under **Settings** > **Songs** > **+ New Son
 
 Once Uploaded the Song will be playable!
 
+
+## Getting Started with local development
+1. Prerequisites:
+   1. Install NodeJS: https://nodejs.org/
+   2. Install Rust: https://rustup.rs/
+   3. Install MariaDB: https://mariadb.org/
+2. Create a new Database:
+   1. On Windows open the `MySQL Client` Software, On Linux run the `mysql` command.
+   2. Run the following commands in mysql:
+   ```
+   create database Singularity;
+   grant all privileges on Singularity.* TO 'Singularity'@'%' identified by 'SECURE_PASSWORD';
+   flush privileges;
+   ```
+
+3. Clone the repository `git clone https://github.com/Singularity-Game/Singularity.git`
+4. Create the file `apps/singularity-api/src/config/appsettings.development.env` with the following content:
+    ```
+    DB_HOST=localhost
+    DB_PORT=3306
+    DB_USERNAME=Singularity
+    DB_PASSWORD=SECURE_PASSWORD
+    DB_DATABASE=Singularity
+
+    SMTP_SECURE=
+    SMTP_HOST=
+    SMTP_PORT=
+    SMTP_USERNAME=
+    SMTP_PASSWORD=
+    SMTP_FROM=
+
+    ENABLE_YOUTUBE=true
+
+    APP_URL=http://localhost:4200
+
+    SONG_DIRECTORY=../../../songs
+
+    AUTHENTICATION_JWT_SECRET=RANDOM_STRING_OF_CHARACTERS   
+    ```
+5. Create the file `ormconfig.ts` in the root directory (next to `package.json`) with the following content:
+    ```ts
+    import { DataSource } from 'typeorm';
+    export const connectionSource = new DataSource({
+        migrationsTableName: 'migrations',
+        type: 'mariadb',
+        host: 'localhost',
+        port: 3306,
+        username: 'Singularity',
+        password: 'SECURE_PASSWORD',
+        database: 'Singularity',
+        logging: false,
+        synchronize: false,
+        name: 'default',
+        entities: ['**/*.entity.ts'],
+        migrations: ['apps/api/src/migrations'],
+    });
+    ```
+6. Install Dependencies for Rust:
+    ```sh
+    rustup install stable
+    rustup override set stable
+    rustup target add wasm32-unknown-emscripten --toolchain stable
+    cargo install wasm-pack
+    ```
+7. Run `npm install`
+8. Run `npm run start`
+9. Run `npm run start-api`
+10. Open your Browser on `http://localhost:4200`
+11. The default credentials are Username: `admin` and Password: `admin`
+
+### Database Migrations
+When you add, remove, or modify Entity Models, you must create a database migration. Typeorm can automatically generate Database Migrations with the following command:
+```
+npm run typeorm migration:generate -- -- ./apps/singularity-api/src/migrations/MIGRATION_NAME
+```
+
+### Icons
+Icons are taken from https://iconoir.com/ 
+
 ## Credits
 - This project is heavily inspired by [Performous!](https://github.com/performous/performous)
 - This project uses the Pitch Detection library from [Vocalous](https://github.com/vocalous/app) and [pitch detection app!](https://alesgenova.github.io/pitch-detection-app/)