Skip to content

Commit 233d215

Browse files
committed
docs: add TL;DR section and update standalone build instructions in README.
1 parent 21b7861 commit 233d215

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,21 @@
22

33
A clean Next.js frontend for interacting with a CopyParty file server. Log in using your server password, browse directories, upload and delete files, and quickly search — all proxied through a secure API route that never stores your password in the browser.
44

5+
## TL;DR - How to run
6+
7+
```bash
8+
# Download the latest Standalone Build from Releases
9+
wget https://github.com/andrecrjr/cool-copyparty-front/releases/latest/download/copyparty-front.zip
10+
11+
# Unzip it
12+
unzip copyparty-front.zip
13+
14+
# Set environment variables (at minimum a strong cookie secret, and your desired port)
15+
COOKIE_SECRET=your-long-random-secret PORT=3925 NODE_ENV=production node server.js
16+
17+
# Open http://localhost:3925 and log in with your CopyParty server URL and password.
18+
```
19+
520
## Features
621
- Connect to any reachable CopyParty server via URL
722
- Directory listing with grid/list views and breadcrumb navigation
@@ -28,11 +43,11 @@ A clean Next.js frontend for interacting with a CopyParty file server. Log in us
2843
You can self-host in two ways: using a prebuilt ZIP from Releases (standalone build), or building locally.
2944

3045
### Option A: Download ZIP from GitHub Releases (standalone)
31-
1. Download the latest `build-front.zip` from the project’s Releases page.
32-
- `wget https://github.com/andrecrjr/copyparty-front/releases/0.0.1/download/build-front.zip` or latest one check the Releases page.
46+
1. Download the latest `Standalone Build` from [Releases](https://github.com/andrecrjr/cool-copyparty-front/releases) page.
47+
- `wget https://github.com/andrecrjr/cool-copyparty-front/releases/latest/download/copyparty-front.zip` or latest one check the Releases page.
3348
- Alternatively, build it yourself using the instructions below.
34-
2. Unzip it: `unzip build-front.zip` (this creates `build-front/`).
35-
3. Change into the standalone bundle: `cd build-front/.next/standalone`.
49+
2. Unzip it: `unzip copyparty-front.zip` (this creates `copyparty-front/`).
50+
3. Change into the standalone bundle: `cd copyparty-front/.next/standalone`.
3651
4. Set environment variables (at minimum a strong cookie secret, and your desired port):
3752
- macOS/Linux: `COOKIE_SECRET=your-long-random-secret PORT=3925 NODE_ENV=production node server.js`
3853
- Windows (PowerShell): `$env:COOKIE_SECRET="your-long-random-secret"; $env:PORT="3925"; $env:NODE_ENV="production"; node server.js`

0 commit comments

Comments
 (0)