Mirrors/Stirling-PDF
Mirrors/Stirling-PDF
1
0
Fork 0
mirror of https://github.com/Frooodle/Stirling-PDF.git synced 2025-02-21 00:17:05 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated CONTRIBUTE.md

Browse Source
This commit is contained in:
Felix Kaspar 2023-10-22 01:18:04 +02:00
parent f6b4479200
commit 2dfb90d0e5
1 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
CONTRIBUTE.md
View File

@ -11,8 +11,20 @@ This file should introduce you with the concepts and tools used in this project.
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
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.js)\
[Functions Folder](/functions/)
Examples that go in the node-functions folder: server-side-only functions, different implementation for backend
### Frontend
[Register Functions](/public/functions.js)\
[Functions Folder](/public/functions/)
Examples that go in the browser-functions folder: client-side-only functions, shared functions