chore: update documentation

.env.example

@@ -1,3 +1,5 @@
+# Read what every environment variable does: https://github.com/stonith404/pingvin-share#environment-variables
+
 # GENERAL
 APP_URL=http://localhost:3000
 SHOW_HOME_PAGE=true

.gitignore

@@ -35,6 +35,5 @@ yarn-error.log*
 /frontend/public/sw.*
 
 # project specific
-/backend/uploads/
+/backend/data/
 /data/
-/backend/prisma/pingvin-share.db*

README.md

@@ -49,9 +49,9 @@ Contact me, create an issue or directly create a pull request.
 
 ### Development setup
 
-#### Database & Backend
+#### Backend
 
-1. Open the `backend`
+1. Open the `backend` folder
 2. Duplicate the `.env.example` file, rename the duplicate to `.env` and change the environment variables if needed
 3. Install the dependencies with `npm install`
 4. Push the database schema to the database by running `npx prisma db push`
@@ -59,9 +59,10 @@ Contact me, create an issue or directly create a pull request.
 
 #### Frontend
 
-1. Open the `frontend` folder
+1. Start the backend first
-2. Duplicate the `.env.example` file, rename the duplicate to `.env` and change the environment variables if needed
+2. Open the `frontend` folder
-3. Install the dependencies with `npm install`
+3. Duplicate the `.env.example` file, rename the duplicate to `.env` and change the environment variables if needed
-4. Start the frontend with `npm run dev`
+4. Install the dependencies with `npm install`
+5. Start the frontend with `npm run dev`
 
 You're all set!

backend/.dockerignore

@@ -1,3 +0,0 @@
-/frontend/node_modules/
-dist/
-.git/

backend/docker-compose.yml

@@ -1,15 +0,0 @@
-version: '3.8'
-services:
-  db:
-    image: postgres:14.1-alpine
-    restart: always
-    environment:
-      - POSTGRES_USER=${DB_USER}
-      - POSTGRES_PASSWORD=${DB_PASSWORD}
-      - POSTGRES_DB=pingvin-share
-    ports:
-      - '5432:5432'
-    volumes:
-      - pingvin-share-dev-db:/var/lib/postgresql/data
-volumes:
-  pingvin-share-dev-db:

frontend/.dockerignore

@@ -1,4 +0,0 @@
-node_modules/
-dist/
-.next/
-.git/