From 59acc534faa8faa2eb8372b971fcc5434fbe83d3 Mon Sep 17 00:00:00 2001 From: Ema Date: Wed, 10 Dec 2025 22:34:29 -0500 Subject: [PATCH] Cleaning readme. --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7722817..7df0aad 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,10 @@ # Sucker -Standalone branch for next and Docker. This branch adds `next.config.js` along with changes to `dockerfile` to build Sucker with only the required dependencies and server components. +### Usage -It is intended to build and run Sucker through Docker. Pull this repository and run `docker build -t .` and `docker compose up` in the project directory. The container will expose the next server on port 3000; this can be changed in `docker-compose.yml` as needed. +Pull this repostory and build with `npm run build`. You can start the server with `node ./.next/standalone/server.js` -If for whatever reason you want to build and run this branch on the host, build with `npm run build` and start the server with `node ./.next/standalone/server.js` - -Todo: Publish to GHCR(?) +You can also build and run Sucker as a Docker container with `docker compose build` and `docker compose up`. ### Changelog