Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dpuscher/contentful-secret-field
A custom Contentful extension for managing fixed-length secret strings.
https://github.com/dpuscher/contentful-secret-field
contentful contentful-app contentful-custom-fields contentful-ui-extension field-extensions react typescript
Last synced: 14 days ago
JSON representation
A custom Contentful extension for managing fixed-length secret strings.
- Host: GitHub
- URL: https://github.com/dpuscher/contentful-secret-field
- Owner: dpuscher
- License: mit
- Created: 2025-01-11T20:06:02.000Z (16 days ago)
- Default Branch: main
- Last Pushed: 2025-01-12T00:00:37.000Z (16 days ago)
- Last Synced: 2025-01-12T00:25:32.833Z (16 days ago)
- Topics: contentful, contentful-app, contentful-custom-fields, contentful-ui-extension, field-extensions, react, typescript
- Language: TypeScript
- Homepage:
- Size: 1.95 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Contentful Secret Field App
This project provides a custom field app for Contentful to handle ramdom string values of fixed length (like a secret).
## Installation
1. Clone the repo.
2. Install dependencies:
```bash
npm install
```
3. Start the development server:
```bash
npm run start
```
## Usage
• Deploy or host this app in your Contentful environment.
• Configure it as a field extension where you need a random secret value.
## Creating a Contentful App
Follow these steps to create and configure your Contentful app from the terminal:
1. **Create a new app definition**:
```bash
npm run create-app-definition
```
2. **Build the app**:
```bash
npm run build
```
3. **Upload the app**:
```bash
npm run upload
```
4. **Use the app in your content model**:
- Edit your content model and add a new field.
- Set the field type to **Short Text**.
- Under **Appearance**, select your custom app.
- Ensure the field is set to **required**.
- Set the **limit character count** options (min and max) to the same number as the **secret length** option of the app.
## Contributing
Feel free to open issues or submit pull requests!
## License
MIT License