Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/onedoclabs/dev-local
A small repository for local PDF development with Fileforge
https://github.com/onedoclabs/dev-local
Last synced: 7 days ago
JSON representation
A small repository for local PDF development with Fileforge
- Host: GitHub
- URL: https://github.com/onedoclabs/dev-local
- Owner: OnedocLabs
- License: apache-2.0
- Created: 2024-02-04T00:53:59.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-09-07T15:51:40.000Z (2 months ago)
- Last Synced: 2024-09-07T17:22:30.951Z (2 months ago)
- Language: TypeScript
- Homepage: https://www.fileforge.com
- Size: 2.55 MB
- Stars: 10
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Dev Local
The new way to build documents.
High-quality, unstyled components for creating PDFs.
---
# 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.
```yaml
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](https://marketplace.visualstudio.com/items?itemName=mathematic.vscode-pdf) 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: true` in `./src/render.tsx`.