Dan's Plugins Community Website

Description

Dan's Plugins Community Website is the central hub for the Dan's Plugins Community. It showcases DPC plugins, provides links to documentation and support resources, and acts as the public face of the community at https://dansplugins.com.

This repository holds both halves of the site:

Path	What it is	Toolchain
repository root	The Next.js front end (pages/, components/, services/, utils/)	Node.js 18.17+
dpc-api/	The Spring Boot back end serving community data (accounts, likes, factions, the plugin catalogue)	Java 17, Maven (via the bundled ./mvnw)

Front-end work needs only Node.js. Back-end work also needs Java 17. Running the whole stack locally is easiest with Docker Compose — see Development.

Installation

First Time Installation

These steps run the front end on its own. Features backed by the API (accounts, likes, the leaderboard) need dpc-api running too; see Development.

1. Ensure Node.js (v18.17 or later, the floor Next.js 14 requires) is installed on your machine.
2. Clone this repository: git clone https://github.com/Dans-Plugins/dansplugins-dot-com.git
3. Install dependencies:

   npm install

4. Build the project:

   npm run build

5. Start the server:

   npm run start

The site will be available at http://localhost:3000.

Other Ways to Run It

npm run dev is the day-to-day development server, and Docker Compose brings up the whole stack including dpc-api. See the Development section below for both.

Usage

Documentation

• User Guide – Getting started and common scenarios
• Configuration Guide – Detailed configuration options
• API Documentation – The dpc-api back end: endpoints, configuration and local setup
• Resource Hub Design – How the plugin catalogue grows into full resource pages
• Changelog – Release history

Website

• dansplugins.com

Support

You can find the support Discord server here.

Experiencing a bug?

Please fill out a bug report here.

• Known Bugs

Usage reporting

When the server is given a trace key in USAGE_REPORTING_KEY, it reports one page-view event per HTML page it serves to trace, as the program dansplugins-dot-com, carrying the page's path (for example /about — never a query string or fragment) and the site version. Public profile pages are recorded as /u/[username], never with the username. Nothing about the visitor is sent: no IP address, user agent, cookie, session, account or referrer. No script is added to any page — the report is made by the server (Next.js middleware), so the key never reaches the browser — and crawlers, uptime monitors, prefetches, API calls, assets and 404s are not counted.

Every page view also carries a random installation ID for the server (the tag install), so trace can count installations of the site rather than raw events. It is a UUID made when the server first reports, derived from nothing about the server or any visitor. TRACE_INSTALL_ID, when set, is used as is; otherwise the client is pointed at $XDG_DATA_HOME/dansplugins-dot-com/trace-install-id (or ~/.local/share/dansplugins-dot-com/trace-install-id). The report is made from Next.js middleware, which runs in the Edge runtime and has no file system, so in practice the ID lives in memory for the life of the server process: each restart or redeploy counts as a new installation unless TRACE_INSTALL_ID is set. To reset it, restart the server or change TRACE_INSTALL_ID (or delete the file, where a runtime with file access created one). Every switch below also stops it: with reporting off no ID is made, read or written.

Reporting is off unless a key is set, and any of these turns it off:

• USAGE_REPORTING_ENABLED=false in the server's environment
• TRACE_USAGE_REPORTING=off in the environment (also false, 0, no; shared by every program that reports to trace, and it wins over the setting above)
• DO_NOT_TRACK=1 in the environment (also true, yes; see consoledonottrack.com)
• leaving USAGE_REPORTING_KEY unset

USAGE_REPORTING_ENDPOINT sends the reports to a different trace server. With a key set, the server logs one line on its first request saying whether reporting is on and, if it is off, which switch turned it off. Details: https://danielstephenson.dev/usage-reporting

Contributing

• CONTRIBUTING.md
• Notes for Developers

Testing

Lint

npm run lint

If you see no errors, the lint check has passed.

Unit Tests

The frontend uses Vitest for unit tests. Run the suite with:

npm test

Test files live in the __tests__/ directory. If all tests pass, the suite has succeeded.

Backend (dpc-api/)

If the change touches dpc-api/:

cd dpc-api && ./mvnw verify

CI runs the front-end checks and this one as separate jobs on every pull request.

Development

Hot-Reloading Dev Server

npm run dev is the hot-reloading path — edits are picked up without a restart:

npm run dev

On its own it serves the front end only, against whatever NEXT_PUBLIC_API_URL points at.

Full Local Stack (Docker Compose)

Docker Compose brings up the site together with dpc-api, its database, and the UserAuth service the API delegates authentication to. The site runs as a production build here, so it does not hot-reload: source is copied into the image, and changes need a rebuild (./up.sh rebuilds).

Setup

1. Install Docker Desktop.
2. Install the site's dependencies on the host:

   npm install

   This step is not optional: compose.yml bind-mounts ./node_modules into the website container, so on a fresh clone with no host node_modules the container starts against an empty directory and fails to launch.
3. Set JWT_SECRET — the stack will not start without it. Either export it, or put it in a .env file in the project root (git-ignored):

   export JWT_SECRET="your-secret-key-at-least-32-bytes-long"

   See CONFIG.md for what it does and the other variables available.
4. Start the stack:

   ./up.sh

   The site will be accessible at http://localhost:3000 and the API at http://localhost:45345. The website container does not start until dpc-api reports healthy — which in turn waits on its database and on UserAuth — so expect a minute or so before localhost:3000 answers on a cold start. The wait is deliberate: the home page's "Latest" chips and a resource page's Versions section are read from dpc-api while rendering, and a page served before the API was up would simply omit them.

Stopping the Server

./down.sh

Authors

Developers

Name	Main Contributions
Dans	Project founder and lead developer

License

This project is licensed under the MIT License.

You are free to use, modify, and distribute this software, provided that the original copyright and license notice are included.

See the LICENSE file for the full text.

Project Status

This project is in active development.