Skip to content

README.md

Latest commit

 

History

History
89 lines (59 loc) · 2.69 KB

README.md

File metadata and controls

89 lines (59 loc) · 2.69 KB
Raw

Platy Paste (frontend)

The front end that can be used to create, and view pastes!

Warning

This project is currently in beta.

See more.

Features

Below is a list of features. The checked boxes mean they have been implemented.

  • Pages
    • Create
      • Add multiple documents.
      • Error handling when pastes fail to upload.
      • Support tab indenting text.
      • Support more file types.
      • Autodetect file type from name.
      • Expiry support.
    • View
      • View documents.
      • Shiki support.
  • UI
    • More consistency. (General theming and UI design)
    • Support mobile.
    • Light / Dark theme.
  • Proper Error handling.

Beta

This whole project is currently a beta.

Internals will be changed, with both the backend and frontend.

Any pastes uploaded during the beta, will be at risk of deletion, so please do not store anything important here.

No data is encrypted as of yet, so also do not save passwords or private information. (this should be a given, no paste can currently be password protected, with no certainty this feature will ever happen.)

Setup

This application is currently built and made for Cloudflare Pages.

Step 1

The first step to hosting your own site, is to fork this repository. more

Step 2

You then need to navigate to the cloudflare pages in your cloudflare account, and link your github. more

Step 3

After linking your git account, follow the steps to select the repository (this one that you have cloned).

Once on the Build Settings page, follow the following settings.

You can use the default SvelteKit framework preset, or use the following settings:

Build command: npm run build

Build output directory: .svelte-kit/cloudflare

You need to at least set the PUBLIC_API_URL environment variable for the site to be able to create/view pastes, and the PUBLIC_CDN_URL, as it will be were the documents are fetched from.

Example environment:

PUBLIC_API_URL = "https://paste.example.com"
PUBLIC_CDN_URL = "https://cdn.example.com"

Step 4

You can now build and host the site!

Tip

Make sure the environment variable for the backend that allows CORS bypass matches the site the pastebin is hosted on!

Important Links