create-backan

Create BACKAN project

BACKAN Create endpoints with type validations and OpenApi documentation, safely and quickly.

This package contains BACKAN Create library

A CLI for creating new Backan project.

CLI

# using NPM
npm create backan@latest
# using PNPM
pnpm create backan@latest
# using YARN
yarn create backan@latest
# using BUN
bun create backan@latest

API

You can also use create-backan programmatically

import { create } from 'create-backan';

await create( {
	input    : '.',
	name     : 'my-app-name',
	template : 'demo', 
	install  : false, 
	open     : 'code',
});

Parameters

export type CreateParams = {
    /**
     * Directory to build.
     *
     * @default .
     */
	input?: string
    /**
     * The name of the project & dirmane.
     */
	name?: string
    /**
     * The template to use for the project.
     *
     * @default demo
     */
	template?: typeof TEMPLATES[keyof typeof TEMPLATES]
    /**
     * Whether to automatically install dependencies after creating the project.
     *
     * @default false
     */
	install?: typeof INSTALL_OPTS[keyof typeof INSTALL_OPTS]
    /**
     * Specifies whether to open the project in an IDE or text editor after creation.
     * Can be `false` for no IDE, or specify an IDE/editor to open.
     * Supported options include:
     * - `'code'`: Visual Studio Code
     * - `'subl'`: Sublime Text
     * - `'webstorm'`: WebStorm.
     *
     * @default false
     */
	open?: typeof OPEN_OPTS[keyof typeof OPEN_OPTS]
}

Examples

npm create backan@latest --name=my-app-name --template='skeleton' --open='code' --install='npm'

pnpm create backan@latest --name=my-app-name --template='skeleton' --open='code' --install='pnpm'

library

Now it's time to start with backan. Read more

More from Backan

• Documentation
  • 📚 Library
  • 🏁 Create (setup)
  • 🗄️ Server
  • 📦 Builder
• Installation

👨‍💻 Development

BACKAN is an open-source project and its development is open to anyone who wants to participate.

☕ Donate

Help us to develop more interesting things.

📜 License

This software is licensed with GPL-3.0.

🐦 About us

PigeonPosse is a ✨ code development collective ✨ focused on creating practical and interesting tools that help developers and users enjoy a more agile and comfortable experience. Our projects cover various programming sectors and we do not have a thematic limitation in terms of projects.

Collaborators

	Name	Role	GitHub
	Angelo	Author & Development	@Angelo
	PigeonPosse	Collective	@PigeonPosse