https://github.com/aryasaatvik/contentful-typescript-types

Generate TypeScript typings from Contentful content types
https://github.com/aryasaatvik/contentful-typescript-types

content-types contentful types typescript

Last synced: about 1 month ago
JSON representation

Generate TypeScript typings from Contentful content types

• Host: GitHub
• URL: https://github.com/aryasaatvik/contentful-typescript-types
• Owner: aryasaatvik
• License: mit
• Created: 2023-10-21T06:09:42.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-23T01:46:00.000Z (about 1 year ago)
• Last Synced: 2024-10-02T07:42:10.841Z (about 1 month ago)
• Topics: content-types, contentful, types, typescript
• Language: TypeScript
• Homepage:
• Size: 19.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Contentful TypeScript Types

This is a typescipt package that generates typescript types from the contentful content models.

## Installation

```bash

npm install contentful-typescript-types

```

## Usage

create a .env file with the following variables at the root of your project

```bash

CONTENTFUL_MANAGEMENT_ACCESS_TOKEN="contentful management access token"

CONTENTFUL_SPACE_ID="contentful space id"

CONTENTFUL_ENVIRONMENT_ID="contentful environment id"

```

then run the following command

```bash

npx contentful-typescript-types

```

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

## License

[MIT](./LICENSE)