kamp/pingvin-share
1
0
Fork 0
mirror of https://github.com/stonith404/pingvin-share.git synced 2024-11-04 23:10:13 +01:00
Code
A self-hosted file sharing platform that combines lightness and beauty, perfect for seamless and efficient file sharing.
8 Commits 6 Branches 82 Tags 35 MiB
TypeScript 99.8%
Dockerfile 0.1%
7c9d496e77
Go to file
Elias Schneider 7c9d496e77
Create LICENSE
2022-04-26 08:15:49 +02:00
.setup fixed expiration date 2022-04-25 17:58:03 +02:00
assets/screenshots initial commit 2022-04-25 15:15:17 +02:00
functions initial commit 2022-04-25 15:15:17 +02:00
public initial commit 2022-04-25 15:15:17 +02:00
src fixed expiration date 2022-04-25 17:58:03 +02:00
styles initial commit 2022-04-25 15:15:17 +02:00
.dockerignore initial commit 2022-04-25 15:15:17 +02:00
.env.example fixed expiration date 2022-04-25 17:58:03 +02:00
.eslintrc.json initial commit 2022-04-25 15:15:17 +02:00
.gitignore initial commit 2022-04-25 15:15:17 +02:00
appwrite.json initial commit 2022-04-25 15:15:17 +02:00
docker-compose.yml initial commit 2022-04-25 15:15:17 +02:00
Dockerfile initial commit 2022-04-25 15:15:17 +02:00
LICENSE Create LICENSE 2022-04-26 08:15:49 +02:00
next-env.d.ts initial commit 2022-04-25 15:15:17 +02:00
next.config.js initial commit 2022-04-25 15:15:17 +02:00
package-lock.json initial commit 2022-04-25 15:15:17 +02:00
package.json fixed expiration date 2022-04-25 17:58:03 +02:00
README.md renamed env variable 2022-04-25 17:16:17 +02:00
tsconfig.json initial commit 2022-04-25 15:15:17 +02:00

README.md


Pingvin Share

Pingvin Share is a selfhosted file sharing plattform made for the Appwrite Hackathon.

Showcase

https://pingvin-share.dev.eliasschneider.com

Setup

At the moment, the setup is a bit time-consuming. I will improve the setup in the future.

1. Appwrite

Pingvin Share uses Appwrite as backend. You have to install and setup Appwrite first

  1. Install Appwrite
  2. Create an Account on your Appwrite instance
  3. Change the _APP_STORAGE_LIMIT variable in the .env file of Appwrite to your prefered max size limit per share

2. Setup script

To setup the backend structure of Pingvin Share you have to run the setup script.

  1. Install Node
  2. Clone the repository with git clone https://github.com/stonith404/pingvin-share
  3. Visit the repository directory with cd pingvin-share
  4. Run npm run init:appwrite

3. Frontend

To set up the frontend of Pingvin Share follow these steps.

  1. Go to your Appwrite console, visit "API Keys" and copy the "Functions API Key" secret to your clipboard.
  2. Rename the .env.example file to .env
  3. Paste the key in the .env file
  4. Change NEXT_PUBLIC_APPWRITE_HOST in the .env file to the host where your Appwrite instance runs
  5. Change NEXT_PUBLIC_MAX_FILE_SIZE in the .env file to the max file size limit you want

Start the frontend:

With docker:

  1. Run docker-compose up -d --build

Without docker:

  1. Run npm install
  2. Run npm run build && npm run start

Contribute

You're very welcome to contribute to Pingvin Share! Contact me, create an issue or directly create a pull request.