From 6b0b9794147dd241375f2701e7e727df6634d527 Mon Sep 17 00:00:00 2001 From: Elias Schneider Date: Fri, 2 Dec 2022 20:33:17 +0100 Subject: [PATCH] docs: updated README for new version --- CONTRIBUTING.md | 16 +++++++++------- README.md | 24 ++++-------------------- 2 files changed, 13 insertions(+), 27 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bebc9ee9..b4e0f122 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,10 +3,11 @@ We would ❤️ for you to contribute to Pingvin Share and help make it better! All contributions are welcome, including issues, suggestions, pull requests and more. ## Getting started + You've found a bug, have suggestion or something else, just create an issue on GitHub and we can get in touch 😊. +## Submit a Pull Request -## Submit a Pull Request Once you created a issue and you want to create a pull request, follow this guide. Branch naming convention is as following @@ -74,20 +75,21 @@ The backend is built with [Nest.js](https://nestjs.com) and uses Typescript. #### Setup 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` +2. Install the dependencies with `npm install` +3. Push the database schema to the database by running `npx prisma db push` +4. Seed the database with `npx prisma db seed` 5. Start the backend with `npm run dev` ### Frontend + The frontend is built with [Next.js](https://nextjs.org) and uses Typescript. #### Setup + 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` +3. Install the dependencies with `npm install` +4. Start the frontend with `npm run dev` You're all set! diff --git a/README.md b/README.md index 20332672..7c692eef 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ Demo: https://pingvin-share.dev.eliasschneider.com ## ✨ Features +- Spin up your instance within 2 minutes - Create a share with files that you can access with a link - No file size limit, only your disk will be your limit - Set a share expiration @@ -21,31 +22,14 @@ Demo: https://pingvin-share.dev.eliasschneider.com > Pleas note that Pingvin Share is in early stage and could include some bugs -1. Download the `docker-compose.yml` and `.env.example` file. -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` +1. Download the `docker-compose.yml` file +2. Run `docker-compose up -d` The website is now listening available on `http://localhost:3000`, have fun with Pingvin Share 🐧! -### Environment variables - -| Variable | Description | Possible values | -| ------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | --------------- | -| `APP_URL` | On which URL Pingvin Share is available. E.g http://localhost or https://pingvin-share.com. | URL | -| `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 | -| `ALLOW_UNAUTHENTICATED_SHARES` | Whether a user can create a share without being signed in. | true/false | -| `MAX_FILE_SIZE` | Maximum allowed size per file in bytes. | Number | -| `JWT_SECRET` | Long random string to sign the JWT's. | Random string | -| `EMAIL_RECIPIENTS_ENABLED` | Whether email reciepients are enabled. Only set this to true if you entered the host, port, email and password of your SMTP server. | true/false | -| `SMTP_HOST`, `SMTP_PORT`, `SMTP_EMAIL`, `SMTP_PASSWORD` | Credentials for your SMTP server. | - | - ### Upgrade to a new version -1. Check if your local `docker-compose.yml` and `.env` files are up to date with the files in the repository -2. Run `docker compose pull && docker compose up -d` to update your docker container - -> Note: If you installed Pingvin Share before it used Sqlite, you unfortunately have to set up the project from scratch again, sorry for that. +Run `docker compose pull && docker compose up -d` to update your docker container ## 🖤 Contribute