Developer Overview¶
There are four ways to build on the system. Pick the lightest one that does what you need.
| Way | What it is | Runs code in the server? | Licence of your work |
|---|---|---|---|
| Extension pack | A file of data: workflow rules, Report Builder reports, document templates, input form settings, numbering, a dashboard layout | No | Your choice |
| Theme | A file of colours and corner shape | No | Your choice |
| Outside app | Your own program that uses the API and webhooks | No, it runs elsewhere | Your choice |
| Core contribution | Go code added to this repository | Yes, after review | The core's licence |
Why modules don't run code inside the server¶
Packs, themes and outside apps can't run code inside someone's installation, so installing one can't break it or read data it wasn't given. A pack only uses the system's own types: its workflow rules arrive switched off, and the installer reviews what it adds before agreeing. An outside app only gets what its API key's user is allowed.
Go can't load plugins at runtime on every platform, so the built-in modules (Inventory, Production, CRM and the others) are compiled into the program and switched on and off as packages. A new module of that kind comes in as a contribution.
File formats are versioned¶
Each file has a format and a version:
| File | format |
Current version |
|---|---|---|
| Extension pack | nbs-pack |
1 |
| Theme | nbs-theme |
1 |
| Trade document | nbs-trade |
1 |
A system refuses a file whose version it doesn't know. Future versions will only add fields, and a change that breaks old files gets a new version number.
Next¶
- Architecture: how the code is laid out.
- Publishing to the Marketplace.