https://github.com/dbtek/docboox
A featured documents gallery api that supports customization on docx templates stored in S3.
https://github.com/dbtek/docboox
Last synced: 5 months ago
JSON representation
A featured documents gallery api that supports customization on docx templates stored in S3.
- Host: GitHub
- URL: https://github.com/dbtek/docboox
- Owner: dbtek
- Created: 2021-01-30T11:39:01.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-22T13:20:00.000Z (over 1 year ago)
- Last Synced: 2025-05-13T14:23:46.567Z (about 1 year ago)
- Language: TypeScript
- Size: 355 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
docboox
===
A featured documents gallery api that supports customization on docx templates stored in S3.
### Features
- JWT authentication
- List docs in an S3 bucket.
- Text replacement in docx templates with query params.
- Download files.
- (upcoming) Upload files.
- (upcoming) Excel, PowerPoint processing.
### API
**GET /api/docs**
Lists files in bucket.
**GET /api/docs/:name**
Downloads file with given name.
**GET /api/docs/:name?foo=bar&baz=qux**
Replaces {foo} with bar and {baz} with qux in docx document with given name and downloads it.
### Environment Variables
While in development, you can add a `.env` file containing following variables:
```
MINIO_SSL=1
MINIO_ENDPOINT=some-minio.com
MINIO_ACCESS_KEY=access_key
MINIO_SECRET_KEY=secret_key
BUCKET=dockboox
```