https://github.com/nottimtam/file-converter-gui
Self-hostable GUI interface for @nottimtam/file-converter.
https://github.com/nottimtam/file-converter-gui
api conversion express file file-converter module
Last synced: about 1 month ago
JSON representation
Self-hostable GUI interface for @nottimtam/file-converter.
- Host: GitHub
- URL: https://github.com/nottimtam/file-converter-gui
- Owner: NotTimTam
- License: mit
- Created: 2024-09-10T02:42:10.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-13T23:55:27.000Z (almost 2 years ago)
- Last Synced: 2024-12-29T01:32:36.995Z (over 1 year ago)
- Topics: api, conversion, express, file, file-converter, module
- Language: JavaScript
- Homepage: https://github.com/NotTimTam/file-converter
- Size: 297 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# file-converter-gui
Self-hostable GUI interface for [@nottimtam/file-converter](https://www.npmjs.com/package/@nottimtam/file-converter).
See [file-converter](https://github.com/NotTimTam/file-converter) for general implementation instructions and API reference.
## Installation
```terminal
npm i @nottimtam/file-converter-gui
```
## Spinup
```terminal
npm start
```
## Environment Variables
For the application to run properly, certain environment variables need to be defined.
### Example
```env
NODE_ENV=development
API_VERSION=1
PORT=3000
CLEAR_JOB_ON_DOWNLOAD=true
FILE_TEMP=./temp
FILE_SIZE_LIMIT=1000000000
DANGEROUSLY_FORCE_CLEAR_TEMP=false
```
### Breakdown
- NODE_ENV
- "production" / "development"
- API_VERSION
- "1" (the only current API version)
- PORT
- The port you want the server to listen on.
- [CLEAR_JOB_ON_DOWNLOAD](https://github.com/NotTimTam/file-converter?tab=readme-ov-file#parameters)
- "true" / "false"
- [FILE_TEMP](https://github.com/NotTimTam/file-converter?tab=readme-ov-file#parameters)
- The directory to store files in during the conversion process.
- [FILE_SIZE_LIMIT](https://github.com/NotTimTam/file-converter?tab=readme-ov-file#parameters)
- An optional maximum upload size in bytes.
- [DANGEROUSLY_FORCE_CLEAR_TEMP](https://github.com/NotTimTam/file-converter?tab=readme-ov-file#parameters)
- "true" / "false" **_(serious consequences for parameter misuse, do not include parameter in `.env` unless absolutely necessary)_**