https://github.com/contentful/node-apps-toolkit
A collection of helpers and utilities for creating NodeJS Contentful Apps
https://github.com/contentful/node-apps-toolkit
app-framework contentful contentful-app
Last synced: 16 days ago
JSON representation
A collection of helpers and utilities for creating NodeJS Contentful Apps
- Host: GitHub
- URL: https://github.com/contentful/node-apps-toolkit
- Owner: contentful
- License: mit
- Created: 2020-09-30T13:30:29.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-03T15:22:51.000Z (22 days ago)
- Last Synced: 2025-04-09T22:11:39.287Z (16 days ago)
- Topics: app-framework, contentful, contentful-app
- Language: TypeScript
- Homepage:
- Size: 2.99 MB
- Stars: 16
- Watchers: 54
- Forks: 4
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Node Toolkit for Contentful Apps
The `node-apps-toolkit` is a growing collection of helpers and utilities for building [Contentful Apps](https://www.contentful.com/developers/docs/extensibility/app-framework/) with Node.js.
## Compatibiltiy
Requires an [Node.js LTS version](https://github.com/nodejs/Release). Currently supported node versions:
- v18
- v20
Odd-numbered and not-yet LTS major versions are not supported.
## Installation
```shell
npm install --save @contentful/node-apps-toolkit
# or
yarn add @contentful/node-apps-toolkit
```
## Available features
- :lock: Request Verification
- :writing_hand: Request Signing
- :bust_in_silhouette: CMA Token generation for App Identities
For more details, check out the [API documentation](https://contentful.github.io/node-apps-toolkit/).
## Example Usage
```js
const { getManagementToken } = require('@contentful/node-apps-toolkit');
const { appInstallationId, spaceId, environmentId, privateKey } = require('./some-constants');
getManagementToken(privateKey, { appInstallationId, spaceId, environmentId })
.then((token) => {
console.log('Here is your app token:', token)
})
```
For more information, check out the full [API documentation](https://contentful.github.io/node-apps-toolkit/).
## More coming soon
We're excited to expand this toolkit with new features. If you have any suggestions or requests for features you'd like to see, please [create an issue](https://github.com/contentful/node-apps-toolkit/issues/new) in this repo.
## Contributing and local development
Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more information on how to contribute to this project.