Skip to content

Commit

Permalink
chore: update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
stonith404 committed Oct 12, 2022
1 parent c689e51 commit 0b9cc3b
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 30 deletions.
2 changes: 2 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,5 @@ yarn-error.log*
/frontend/public/sw.*

# project specific
/backend/uploads/
/backend/data/
/data/
/backend/prisma/pingvin-share.db*
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,19 +49,20 @@ 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`
5. Start the backend with `npm run dev`

#### 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!
3 changes: 0 additions & 3 deletions backend/.dockerignore

This file was deleted.

15 changes: 0 additions & 15 deletions backend/docker-compose.yml

This file was deleted.

4 changes: 0 additions & 4 deletions frontend/.dockerignore

This file was deleted.

0 comments on commit 0b9cc3b

Please sign in to comment.