diff --git a/.env.example b/.env.example index 810e957..46b8886 100644 --- a/.env.example +++ b/.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 diff --git a/.gitignore b/.gitignore index 23c1afd..21d982f 100644 --- a/.gitignore +++ b/.gitignore @@ -35,6 +35,5 @@ yarn-error.log* /frontend/public/sw.* # project specific -/backend/uploads/ +/backend/data/ /data/ -/backend/prisma/pingvin-share.db* diff --git a/README.md b/README.md index da40b80..1284ac3 100644 --- a/README.md +++ b/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 -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. Start the frontend with `npm run dev` +1. Start the backend first +2. Open the `frontend` folder +3. Duplicate the `.env.example` file, rename the duplicate to `.env` and change the environment variables if needed +4. Install the dependencies with `npm install` +5. Start the frontend with `npm run dev` You're all set! diff --git a/backend/.dockerignore b/backend/.dockerignore deleted file mode 100644 index e13e5ca..0000000 --- a/backend/.dockerignore +++ /dev/null @@ -1,3 +0,0 @@ -/frontend/node_modules/ -dist/ -.git/ \ No newline at end of file diff --git a/backend/docker-compose.yml b/backend/docker-compose.yml deleted file mode 100644 index 8e06c39..0000000 --- a/backend/docker-compose.yml +++ /dev/null @@ -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: \ No newline at end of file diff --git a/frontend/.dockerignore b/frontend/.dockerignore deleted file mode 100644 index 8b163dc..0000000 --- a/frontend/.dockerignore +++ /dev/null @@ -1,4 +0,0 @@ -node_modules/ -dist/ -.next/ -.git/ \ No newline at end of file