https://github.com/onedoclabs/fileforge-triggerdev
Sample Fileforge repository leveraging Trigger.dev v3 functions.
https://github.com/onedoclabs/fileforge-triggerdev
document-generator fileforge react triggerdev
Last synced: 4 months ago
JSON representation
Sample Fileforge repository leveraging Trigger.dev v3 functions.
- Host: GitHub
- URL: https://github.com/onedoclabs/fileforge-triggerdev
- Owner: OnedocLabs
- Created: 2024-07-26T11:15:37.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-26T11:29:24.000Z (over 1 year ago)
- Last Synced: 2025-07-05T06:36:48.521Z (6 months ago)
- Topics: document-generator, fileforge, react, triggerdev
- Language: TypeScript
- Homepage: https://www.fileforge.com
- Size: 621 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Trigger.dev (v3) + Fileforge
---
The easiest way to generate documents, reports, and presentations from your data!
**This example is free for most use cases.**
Advantages of using [Trigger.dev](https://trigger.dev) + [Fileforge](https://fileforge.com):
- Stack agnostic: Trigger.dev runs your functions in a runtime compatible with Fileforge. You can trigger your functions from any language or platform, including Python, Node.js, Ruby, Go, Java, and more.
- No infrastructure: rendering documents is a heavy task that requires a lot of resources. Trigger.dev and Fileforge take care of all the infrastructure for you.
- Use React: even if you do not have a React stack, you can use React to generate your documents.
- Easy to monitor: Trigger.dev provides a dashboard where you can see the status of your functions and logs.
## Getting started
### Create a Trigger.dev account
Head to [Trigger.dev](https://trigger.dev) and create an account. You will also be prompted to create a project. If you already are a Trigger.dev user, you can just create a project or use an existing one.
### Create a Fileforge account
Head to [Fileforge](https://fileforge.com) and create an account. Your API key will be displayed on the dashboard.
### Configure the repository
Start by cloning this repository:
```bash
git clone https://github.com/onedoclabs/fileforge-triggerdev.git
cd fileforge-triggerdev
```
Then, install the dependencies:
```bash
npm install
```
### Configure the environment variables
You can copy and rename the `.env.example` file to `.env`:
```bash
cp .env.example .env
```
Then, open the `.env` file and fill in the `TRIGGERDEV_API_KEY` and `FILEFORGE_API_KEY` variables.
- `TRIGGERDEV_API_KEY` can be found in the Trigger.dev dashboard, on the left hand side, under `API Keys`.
- `FILEFORGE_API_KEY` can be found in the Fileforge dashboard, in the dark box at the top.
### Configure the Trigger.dev project ID
You can find the project ID in the Trigger.dev dashboard, on the left hand side, under `Projects`.
Then, open the `trigger.config.ts` file and replace the `triggerProjectID` value with your project ID.
```ts
const triggerProjectID = "your-project-id";
```
## Run the example
### Start the Trigger dev server
This command will start the Trigger dev server. This server will respond to test requests from the Trigger.dev dashboard.
```bash
npm run dev
```
Then, head over to the Trigger.dev dashboard and click on the `Test` button. You should see the function.
### Run a test request
When clicking on the function, you can set a payload value and run the test.
### View the logs
You can now view the logs and your generated document by using the URL logged in the console.
NB: the URL in the return preview is truncated. You should use the console URL to view the full document.
### View the document
You can now view the document generated by the function.
## Deploying
### Set up the Fileforge environment variable
Head to your Trigger.dev dashboard and set the `FILEFORGE_API_KEY` environment variable (under `Environment Variables`) to the value of your Fileforge API key.
### Deploy the function
To deploy the function, use the following command:
```bash
npm run deploy
```