@leogps/file-uploader 2.0.0 → 2.0.1

package/.github/workflows/publish.yml

@@ -0,0 +1,31 @@
+name: Publish NPM
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  id-token: write
+  contents: read
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Use Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version: '24'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install dependencies
+        run: npm ci --include=dev
+
+      - name: Build
+        run: npm run clean && npm run package
+
+      - name: Publish
+        run: npm publish

package/Dockerfile

@@ -0,0 +1,18 @@
+FROM node:24-alpine as build
+
+WORKDIR /srv/file-uploader
+
+COPY package.json package-lock.json ./
+RUN npm ci --production
+
+COPY . .
+RUN npm run clean && npm run package
+
+FROM node:24-alpine
+WORKDIR /srv/file-uploader
+VOLUME /public
+
+COPY --from=build /srv/file-uploader/dist ./dist
+
+EXPOSE 8080
+ENTRYPOINT ["./dist/index.js", "-p", "8080", "-l", "/public"]

package/README.md

@@ -1,34 +1,44 @@
-# File-Uploader Server
+# @leogps/file-uploader
 
 Zero-config command-line tool to run a file-uploader server. Files can be uploaded typically from a browser.
 
 Both Server and Client are written in JS.
 
-## Table of Contents
+## Installation
 
-* [Run](#run-in-production-mode)
-  * [Clean](#clean)
-  * [Build](#build-prod)
-  * [Serve](#serve-prod)
-  * [Configuration Options](#configuration-options)
-* [Run in Development Mode](#run-in-development-mode)
-* [Complete list of commands](#complete-list-of-commands-bunnpm)
+#### Running on-demand:
 
-## Run in Production Mode
+Using `npx` you can run the script without installing it first:
 
-### Clean
+    npx @leogps/file-uploader [path] [options
 
-    npm run clean # or bun run clean (optional)
+#### Globally via `npm`
 
-### Build (Prod)
+    npm install --global @leogps/file-uploader
 
-    npm run build-prod # or bun run build-prod
+#### As a dependency in your `npm` package:
 
-### Serve (Prod)
+    npm install @leogps/file-uploader
 
-    node dist/ # or bun run ./dist/
+#### Using Docker
 
-### Configuration Options
+Note: a public image is not provided currently, but you can build one yourself
+with the provided Dockerfile.
+
+1. Create an image
+   ```
+   docker build -t my-image .
+   ```
+2. Run a container
+   ```
+   docker run -p 8080:8080 -v "${pwd}:/public" my-image
+   ```
+   In the example above we're serving the directory `./` (working directory).
+   If you wanted to serve `./test` you'd replace `${pwd}` with `${pwd}/test`.
+
+### Usage
+
+    file-uploader [path] [options]
 
     --version              Show version number                            [boolean]
     -l, --upload_location  upload location
@@ -36,80 +46,11 @@ Both Server and Client are written in JS.
     -p, --port             server port                                    [number]
         --help             Show help                                      [boolean]
 
-## Run in Development Mode
-
-    npm run start # or bun start
-
-## Complete list of commands (bun|npm)
-
-* `bun|npm run clean`
-
-    ```bash
-    rimraf dist
-    ```
-
-* `bun|npm run precompile`
-
-    ```bash
-    eslint -c .eslintrc.js --fix --ext .ts src src-client
-    ```
-
-* `bun|npm run compile-server`
-
-    ```bash
-    ./node_modules/webpack-cli/bin/cli.js --config webpack.config.js
-    ```
-
-* `bun|npm run compile-client-dev`
-
-    ```bash
-    ./node_modules/webpack-cli/bin/cli.js --config webpack-client.dev.js
-    ```
-
-* `bun|npm run compile-client-prod`
-
-    ```bash
-    ./node_modules/webpack-cli/bin/cli.js --config webpack-client.prod.js
-    ```
-
-* `bun|npm run compile-dev`
-
-    ```bash
-    npm run precompile && npm run compile-server && npm run compile-client-dev
-    ```
-
-* `bun|npm run build-dev`
-
-    ```bash
-    npm run compile-dev
-    ```
-
-* `bun|npm run compile-prod`
-
-    ```bash
-    npm run precompile && npm run compile-server && npm run compile-client-prod
-    ```
-
-* `bun|npm run build-prod`
-
-    ```bash
-    npm run compile-prod
-    ```
-
-* `bun|npm run dev:server`
-
-    ```bash
-    npm run build:server:once && npm-run-all --parallel nodemon:prod watch:client
-    ```
-
-* `bun|npm run start`
-
-    ```bash
-    npm run build-dev && node dist/index.js
-    ```
+# Development
 
-* `bun|npm run package`
+Checkout this repository locally, then:
 
-    ```bash
-    cross-env NODE_ENV=production npm run build-prod && node ./package-gzip.js
-    ```
+```sh
+$ npm i
+$ npm start
+```

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "@leogps/file-uploader",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Facilitates file uploader server.",
   "main": "src/index.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/leogps/file-uploader"
+  },
   "bin": {
     "file-uploader": "./dist/index.js"
   },
@@ -42,7 +46,10 @@
     "client"
   ],
   "author": "Paul Gundarapu",
-  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/leogps/file-uploader/issues"
+  },
+  "license": "MIT",
   "dependencies": {
     "@fortawesome/fontawesome-free": "^5.15.4",
     "bulma": "^1.0.4",