Merge branch 'main' of https://github.com/C4illin/ConvertX

C4illin · Aug 26, 2024 · bb34bde · bb34bde
2 parents 11fcbc3 + f7344e4
commit bb34bde
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 5 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -1,4 +1,4 @@
-FROM oven/bun:1.1.25-alpine AS base
+FROM oven/bun:1.1.26-alpine AS base
 LABEL org.opencontainers.image.source="https://github.com/C4illin/ConvertX"
 WORKDIR /app
 

diff --git a/README.md b/README.md
@@ -51,11 +51,11 @@ services:
       - convertx:/app/data
 ```
 
-<!-- or
+or
 
 ```bash
-docker run ghcr.io/c4illin/convertx:master -p 3000:3000 -e ACCOUNT_REGISTRATION=false -v /path/you/want:/app/data
-``` -->
+docker run ghcr.io/c4illin/convertx -p 3000:3000 -v ./data:/app/data
+```
 
 Then visit `http://localhost:3000` in your browser and create your account. Don't leave it unconfigured and open, as anyone can register the first account.
 
@@ -65,6 +65,15 @@ If you get unable to open database file run `chown -R $USER:$USER path` on the p
 
 Tutorial in french: https://belginux.com/installer-convertx-avec-docker/
 
+## Development
+
+0. Install [Bun](https://bun.sh/) and Git
+1. Clone the repository
+2. `bun install`
+3. `bun run dev`
+
+Pull requests are welcome! See below and open issues for the list of todos.
+
 ## Todo
 - [x] Add messages for errors in converters
 - [ ] Add options for converters
@@ -73,6 +82,10 @@ Tutorial in french: https://belginux.com/installer-convertx-avec-docker/
 - [ ] Add tests
 - [ ] Add searchable list of formats
 - [ ] Make the upload button nicer and more easy to drop files on. Support copy paste as well if possible.
+- [ ] Add more converters:
+  - [ ] [deark](https://github.com/jsummers/deark)
+  - [ ] LibreOffice
+  - [ ] [dvisvgm](https://github.com/mgieseki/dvisvgm)
 
 ## Contributors
 

diff --git a/bun.lockb b/bun.lockb
diff --git a/package.json b/package.json
@@ -30,7 +30,7 @@
     "@ianvs/prettier-plugin-sort-imports": "^4.3.1",
     "@kitajs/ts-html-plugin": "^4.0.2",
     "@picocss/pico": "^2.0.6",
-    "@total-typescript/ts-reset": "^0.5.1",
+    "@total-typescript/ts-reset": "^0.6.0",
     "@types/bun": "^1.1.6",
     "@types/eslint": "^9.6.0",
     "@types/node": "^22.5.0",

diff --git a/src/public/robots.txt b/src/public/robots.txt
@@ -0,0 +1,2 @@
+User-agent: *
+Disallow: /