npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

create-contentful-app

v1.3.24

Published

A template for building Contentful Apps

Downloads

1,624

Readme

Create Contentful App

create-contentful-app is a command line interface used to easily bootstrap Contentful Apps.

Requirements

  • Node.js v18.12 or later
  • npm v9 or later

Usage

To start developing your first app, run:

npx create-contentful-app my-first-app

Screenshot of npx create-contentful-app my-app

Bootstrap

You can run create-contentful-app using one of the following commands:

# npx
npx create-contentful-app <app-name>

# npm
npm init contentful-app <app-name>

# Yarn
yarn create contentful-app <app-name>

CLI Options

Package Manager

--npm or --yarn

Use npm or Yarn to manage dependencies. If omitted, defaults to the manager used to run create-contentful-app.

Both flags are mutually exclusive.

Template

Select between predefined and custom templates:

  • -ts, --typescript: Use TypeScript template (default)
  • -js, --javascript: Use JavaScript template
  • -e, --example <example-name>: Select a predefined template from https://github.com/contentful/apps/tree/master/examples
  • -s, --source <url>: Use a custom template. Format: URL (HTTPS or SSH) or vendor:user/repo (e.g., github:user/repo)

These flags are mutually exclusive. If no flag is provided, the TypeScript template is used.

Help

--help

Shows all available CLI options:

Usage: npx create-contentful-app [options] [app-name]

Bootstrap your app inside a new folder `my-app`

  create-contentful-app my-app

or specify your own template

  create-contentful-app my-app --source "github:user/repo"

Official Contentful templates are hosted at https://github.com/contentful/apps/tree/master/examples.

Arguments:
  app-name                                      app name

Options:
  --npm                                         use npm
  --yarn                                        use Yarn
  -js, --javascript                             use default JavaScript template
  -ts, --typescript                             use default TypeScript template
  -e, --example <example-name>                  bootstrap an example app from https://github.com/contentful/apps/tree/master/examples
  -s, --source <url>                            provide a template by its source repository.
                                                format: URL (HTTPS or SSH) or vendor:user/repo (e.g., github:user/repo)
  -a, --actions                                 includes a hosted app action in ts or js template
  -f, --function <function-template-name>       include the specified function template
  -h, --help                                    shows all available CLI options