@contentful/create-contentful-app

    1.3.6 • Public • Published

    Create Contentful App

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

    Requirements

    • Node.js v14.15 or v16
    • npm v6 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)
      -h, --help                    shows all available CLI options
    

    Install

    npm i @contentful/create-contentful-app

    DownloadsWeekly Downloads

    142

    Version

    1.3.6

    License

    MIT

    Unpacked Size

    20.1 kB

    Total Files

    8

    Last publish

    Collaborators

    • cf-aleks
    • jeffm_cf
    • bvkr
    • ebctfl
    • sjouli
    • mayakarabula
    • cf-engit
    • harshil1712
    • paradoja
    • mattvanvoorst-contentful
    • bruce.felt
    • holgerstorm
    • grassator
    • cf-remylenoir
    • mayagillilan
    • ahsen
    • sergej.herbert
    • mar.contentful
    • rowadz_contentful
    • edblankenship
    • kiyutink_contentful
    • roosterhack
    • kurtulus-contentful
    • omasopust-cf
    • cemre.yuksel
    • peacemukke
    • sophiiistika
    • stephanleece
    • dogukano
    • 3b3ziz
    • or_yoffe_contentful
    • hennadii.shymanskyi
    • m.bensalem
    • sxagoraris
    • stathis.xagoraris
    • andreascful
    • richard_moran
    • yvesrijckaert_contentful
    • mehdi_contentful
    • georgpanok
    • riqwan.thahamir
    • piotr.ciazynski
    • felixboenke
    • farruco.sanjurjo
    • ronaldronson
    • silhoue
    • phbschmidt
    • timbeyer
    • kathrinholzmann
    • inbal.gordon
    • poberherr
    • mikita.savanovich
    • laurenceb
    • stupchiy
    • elblivion
    • fabianheymann
    • it-internal
    • sbezludny
    • medturki
    • danwe
    • marina-cf
    • dlitvakb
    • yann-cf
    • makinwa37
    • diacono
    • whydah-gally
    • tauraz
    • cakejelly
    • martin3walker
    • argvk_cf
    • yiotis
    • leonardofreitass
    • hwartig
    • davidfateh
    • dvasylenko
    • ruderngespra
    • janikomu
    • mshaaban0
    • kdamball
    • burakukula
    • gregferg
    • marcolink
    • gosiaszporer
    • miretxu
    • z0al
    • mspagnolo
    • thomas.spiesser
    • kbarnett
    • jwhiles
    • anho
    • didi96
    • fs
    • cgrabo
    • dana_grn
    • andipaetzold-cf
    • eva.martinez
    • lucabianconi
    • denkristoffer
    • luizfonseca
    • juliabiro
    • vinz93
    • jbourne
    • 0mathcrap
    • damienxy
    • roryscarson
    • m99coder-cf
    • loweisz
    • thomas.contentful
    • marceltoben
    • anwar.ahmad
    • massao
    • bohdan.hutsol
    • contentful-ecosystem
    • vida.momenzadeh
    • yuri.mazursky
    • rebecca.koenig
    • annmary