Infrastructure/pingvin-share
0
Fork 0
mirror of https://github.com/stonith404/pingvin-share.git synced 2025-01-29 01:28:59 -05:00
Code Issues Activity

Update README.md

Browse source
This commit is contained in:
Elias Schneider 2022-10-11 09:17:25 +02:00 • committed by GitHub
parent b30269344d
commit c1522ef35c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -21,7 +21,7 @@ Demo: https://pingvin-share.dev.eliasschneider.com
2. Rename the `.env.example` file to `.env` and change the environment variables so that they fit to your environment. If you need help with the environment variables take a look [here](#environment-variables)
3. Run `docker-compose up -d`
The website is now listening available on `http://localhost:8080`, have fun with Pingvin Share 🐧!
The website is now listening available on `http://localhost:3000`, have fun with Pingvin Share 🐧!
### Environment variables
@ -29,10 +29,10 @@ The website is now listening available on `http://localhost:8080`, have fun with
| -------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------- |
| `APP_URL` | On which URL Pingvin Share is available. E.g http://localhost or https://pingvin-share.com. | URL |
| `BACKEND_URL` | Where the backend is listening on your local machine. If you use the default installation, use `http://backend:8080`. | URL |
| `SHOW_HOME_PAGE` | Wether the Pingvin Share home page should be shown. | true/false |
| `ALLOW_REGISTRATION` | Wether a new user can create a new account. | true/false |
| `SHOW_HOME_PAGE` | Whether the Pingvin Share home page should be shown. | true/false |
| `ALLOW_REGISTRATION` | Whether a new user can create a new account. | true/false |
| `MAX_FILE_SIZE` | Maximum allowed size per file in bytes. | Number |
| `JWT_SECRET` | Random string to sign the JWT's. | Random string |
| `JWT_SECRET` | Random string to sign the JWT's. | Long random string |
## 🖤 Contribute
@ -43,7 +43,7 @@ Contact me, create an issue or directly create a pull request.
#### Database & 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. Start the database by running `docker-compose up -d`