dev-local's Introduction

Dev Local

The new way to build documents.
High-quality, unstyled components for creating PDFs.

Website · GitHub · Discord · Documentation

Getting started

1. Installation

Clone the repository.

npm install

2. Set up environment

Copy the .env.example file to .env and fill in the required fields.

FILEFORGE_API_KEY="your_api_key"

For a live rendering experience, split your IDE in two views, and open invoice.pdf in your right tab. You can use the PDF Viewer extension if you are using VS Code.

3. Render your first document$

npm run render

4. Have fun !

Build and render documents of your own in just one command line !

5. Remove the watermark

By default, this repository has test: false enabled in ./src/render.tsx. To add the watermark and be in test mode, set test: false in ./src/render.tsx.

dev-local's People

Contributors

Stargazers

Watchers

dev-local's Issues

Error during PDF conversion: ReferenceError: File is not defined

I keep getting an error when running npm run render:

import "dotenv/config";

import fs from "fs";
import { FileforgeClient } from '@fileforge/client';
import { compile } from "@fileforge/react-print";
import React from "react";

import { Document } from "./Document";

const ff = new FileforgeClient({
  apiKey:"process.env.FILEFORGE_API_KEY", // replace with your API key
});

(async () => {
  try {
    const HTML = await compile(<Document name="World" />)

    const pdf = await ff.pdf.generate(
      [new File([HTML], "index.html", {
        type: "text/html",
      }),
       new File([fs.readFileSync(__dirname + "/images/fileforge_cover.png")], "fileforge_cover.png", {
        type: "image/png",  
       })
    ],
      {
        options: {
          host: false,
          test: false,
        },
      }
    );

    pdf.pipe(fs.createWriteStream("output.pdf"));
  } catch (error) {
    console.error("Error during PDF conversion:", error);
  }
})();

Recommend Projects