Mirrors/Stirling-PDF
Mirrors/Stirling-PDF
1
0
Fork 0
mirror of https://github.com/Frooodle/Stirling-PDF.git synced 2024-12-21 19:08:24 +01:00
Code Issues Packages Projects Releases Wiki Activity
2dfb90d0e5
Stirling-PDF/CONTRIBUTE.md
Felix Kaspar 2dfb90d0e5 Updated CONTRIBUTE.md
2023-10-22 01:18:04 +02:00

1.2 KiB
Raw Blame History

Contribute

This file should introduce you with the concepts and tools used in this project.

PDF Library Docs

Adding a PDF Function

In order to add a PDF-Function there are several files that need to be changed. If the function is on the backend only, or on only on the frontend, you just need to add it to one of the locations. If it is available on both, you need to update both locations. Dependency Injection is used to accomodate for different imports across platforms.

Backend functions can have different implementations than their frontend counterparts if neccesary. Otherwise they can just link to their frontend implementation.

Registering functions will also pass them their dependencies for the specific target platform (Node, Browser)

Backend

Register Functions
Functions Folder

Examples that go in the node-functions folder: server-side-only functions, different implementation for backend

Frontend

Register Functions
Functions Folder

Examples that go in the browser-functions folder: client-side-only functions, shared functions