9.0.1 • Published 1 year ago

create-keystone-app v9.0.1

Weekly downloads
521
License
MIT
Repository
-
Last release
1 year ago

Create Keystone app

This is the last active development release of this package as Keystone 5 is now in a 6 to 12 month active maintenance phase. For more information please read our Keystone 5 and beyond post.

A CLI for Keystone to help generate starter apps.

Usage

Interactive

yarn create keystone-app my-app

and follow the prompts.

Non-Interactive

A non-interactive Keystone app creation could be useful in unattended app generation. One such example is creating a Docker image with a generated Keystone app built in. See the list of possible arguments in the Arguments section below.

npm init keystone-app --name "My App" --template "starter" --database "MongoDB" --connection-string mongodb://localhost/MyApp --test-connection false my-app

The app generation will fall back to interactive prompts if any of the arguments are missing or have incorrect values.

Note: By the time this documentation was written, yarn create was not working because the CLI arguments were not passed to the create-keystone-app script.

Arguments

ArgumentTypeDescription
--nameStringThe Keystone app name visible in the Admin UI and page titles.
--templateStringOne of the existing app templates (folder name). For example: starter, todo, etc.
--databaseStringOne of the databases listed in the app template. One of: MongoDB or PostgreSQL.
--connection-stringStringThe connection string to connect to your database.
--test-connectionBooleanTest the database connection before setting up the project.
--dry-runBooleanWill go through the app generation process validating the user inputs or CLI arguments but in the end no app will be generated.

Run the app

cd my-app # Change directory
yarn dev  # Start the development server
9.0.1

1 year ago

9.0.0

1 year ago

8.1.0

1 year ago

8.0.1

2 years ago

8.0.0

2 years ago

8.0.2

2 years ago

7.0.2

2 years ago

7.0.1

2 years ago

7.0.0

2 years ago

6.0.1

2 years ago

6.0.0

2 years ago

5.1.0

3 years ago

5.0.2

3 years ago

5.0.1

3 years ago

5.0.0

3 years ago

4.0.15

3 years ago

4.0.14

3 years ago

4.0.13

3 years ago

4.0.12

3 years ago

4.0.11

3 years ago

4.0.10

3 years ago

4.0.9

3 years ago

4.0.8

3 years ago

4.0.7

3 years ago

4.0.6

3 years ago

4.0.5

3 years ago

4.0.4

3 years ago

4.0.1

3 years ago

4.0.3

3 years ago

4.0.2

3 years ago

4.0.0

3 years ago

3.5.2

3 years ago

3.5.1

3 years ago

3.5.0

3 years ago

3.4.4

3 years ago

3.4.3

3 years ago

3.4.2

3 years ago

3.4.1

4 years ago

3.4.0

4 years ago

3.3.6

4 years ago

3.3.5

4 years ago

3.3.4

4 years ago

3.3.3

4 years ago

3.3.2

4 years ago

3.3.1

4 years ago

3.3.0

4 years ago

3.2.3

4 years ago

3.2.2

4 years ago

3.2.1

4 years ago

3.2.0

4 years ago

3.1.2

4 years ago

3.1.1

4 years ago

3.1.0

4 years ago

3.0.1

4 years ago

3.0.0

4 years ago

2.0.0

4 years ago

1.7.0

4 years ago

1.6.2

4 years ago

1.6.1

4 years ago

1.6.0

4 years ago

1.5.1

4 years ago

1.5.0

4 years ago

1.4.1

4 years ago

1.4.0

4 years ago

1.3.2

5 years ago

1.3.1

5 years ago

1.3.0

5 years ago

1.2.1

5 years ago

1.2.0

5 years ago

1.1.0

5 years ago

1.0.1

5 years ago

1.0.0

5 years ago

0.6.2

5 years ago

0.6.1

5 years ago

0.6.0

5 years ago

0.5.1

5 years ago

0.5.0

5 years ago

0.4.2

5 years ago

0.4.1

5 years ago

0.4.0

5 years ago

0.3.2

5 years ago

0.3.1

5 years ago

0.3.0

5 years ago

0.2.0

5 years ago