https://github.com/insyri/pfs

📂 Server for pasting, uploading, and downloading files.
https://github.com/insyri/pfs

docker docker-compose go nginx postgresql svelte tailwindcss typescript

Last synced: 9 days ago
JSON representation

📂 Server for pasting, uploading, and downloading files.

• Host: GitHub
• URL: https://github.com/insyri/pfs
• Owner: insyri
• License: mit
• Created: 2022-06-07T20:23:23.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-20T20:04:28.000Z (over 1 year ago)
• Last Synced: 2024-06-21T03:16:57.304Z (5 months ago)
• Topics: docker, docker-compose, go, nginx, postgresql, svelte, tailwindcss, typescript
• Language: Go
• Homepage:
• Size: 440 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# pfs

📂 Server for pasting, uploading, and downloading files. Built on an API that serves data to the frontend, allowing both developers and casual i-net users to browse file contents.

[![](https://shields.io/badge/Svelte-05122A?logo=svelte&style=for-the-badge)](https://svelte.dev/)

[![](https://shields.io/badge/Go-05122A?logo=go&style=for-the-badge)](https://go.dev/)

[![](https://shields.io/badge/Docker-05122A?logo=docker&style=for-the-badge)](https://docker.com/)

[![](https://shields.io/badge/TypeScript-05122A?logo=typescript&style=for-the-badge)](https://www.typescriptlang.org/)

[![](https://shields.io/badge/Tailwind%20CSS-05122A?logo=tailwindcss&style=for-the-badge)](https://tailwindcss.com/)

[![](https://shields.io/badge/PostgreSQL-05122A?logo=postgresql&style=for-the-badge)](https://postgresql.org/)

[![](https://shields.io/badge/Nginx-05122A?logo=nginx&logoColor=009639&style=for-the-badge)](https://nginx.org/)

## To start using pfs

pfs uses [Docker](https://www.docker.com/) to create and manage the programs used to make pfs work.

```bash

git clone https://github.com/insyri/pfs

cd pfs

# Create and populate ./pfs.toml, or use the example: ./pfs.example.toml

chmod +x ./start-pfs.sh

./start-pfs.sh --config ./pfs.example.toml

```

## Development

pfs has a [contributing guide](./.github/CONTRIBUTING.md), it contains contributing guidelines and more in-depth development setup specifications.

On \*nix[^1] systems, users can run this one liner in the project directory:

```bash

./start-pfs.sh --env dev --config ./pfs.example.toml

```

For Windows systems, users will have to use WSL and open the project inside the Linux file system.

[^1]: Unix, unix-like, and unix based. E.g.: MacOS, Linux, and Windows Subsystem for Linux.