1.0.0 • Published 2 years ago

create-suncel-app v1.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
2 years ago

Create Suncel App

The easiest way to get started with Suncel is by using create-suncel-app. This CLI tool enables you to quickly start building a new Suncel application, with everything set up for you. You can create a new app using the default Suncel template, or by using one from the Suncel Github. Typescript is included in all the starters. To get started, use the following command:

npx create-suncel-app@latest
# or
yarn create suncel-app
# or
pnpm create suncel-app

To create a new app in a specific folder, you can send a name as an argument. For example, the following command will create a new Suncel app called blog-app in a folder with the same name:

npx create-suncel-app@latest blog-app
# or
yarn create suncel-app blog-app
# or
pnpm create suncel-app blog-app

Options

create-suncel-app comes with the following options:

  • --use-npm - Explicitly tell the CLI to bootstrap the app using npm. To bootstrap using yarn we recommend to run yarn create suncel-app
  • --use-pnpm - Explicitly tell the CLI to bootstrap the app using pnpm. To bootstrap using pnpm we recommend running pnpm create suncel-app

Why use Create Suncel App?

create-suncel-app allows you to create a new Suncel app within seconds. It is officially maintained by the creators of Suncel

What after ?

Having a Suncel is mandatory for using the CMS, so if you don't have one please register here.

In order to use the CMS you will have to put the Suncel API key of your project in the environnement variable of your project, have a look at the Suncel documentation