create-backan
Version:
Quickly create a backan application to get started
209 lines (158 loc) ā¢ 9.85 kB
Markdown
# Create BACKAN project
<!-- PIGEONPOSSE START HEADER -->
[](https://backan.pigeonposse.com/)
[](https://pigeonposse.com)
[](https://pigeonposse.com?popup=about)
[](https://pigeonposse.com/?popup=donate)
[](https://github.com/pigeonposse)
[](https://twitter.com/pigeonposse_)
[](https://www.instagram.com/pigeon.posse/)
[](https://medium.com/@pigeonposse)
[](/LICENSE)
[](https://www.npmjs.com/package/backan)
[**BACKAN**](https://backan.pigeonposse.com/) Create endpoints with type validations and OpenApi documentation, safely and quickly.
<!-- PIGEONPOSSE END HEADER -->
> This package contains **_BACKAN_** Create library
<!-- PIGEONPOSSE START DOCS -->
A `CLI` for creating new [Backan](https://backan.pigeonposse.com) project.
[](https://www.npmjs.com/package/create-backan)
<!--  -->
## CLI
```bash
# 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
```js twoslash
import { create } from 'create-backan';
await create( {
input : '.',
name : 'my-app-name',
template : 'demo',
install : false,
open : 'code',
});
```
## Parameters
```ts
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
```bash
npm create backan@latest --name=my-app-name --template='skeleton' --open='code' --install='npm'
```
```bash
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](https://backan.pigeonposse.com/guide/core/app)
<!-- PIGEONPOSSE END DOCS -->
<!-- PIGEONPOSSE START INDEX -->
## More from Backan
- [Documentation](https://backan.pigeonposse.com/)
- š [Library](https://backan.pigeonposse.com/guide/core)
- š [Create (setup)]( https://backan.pigeonposse.com/guide/create )
- šļø [Server]( https://backan.pigeonposse.com/guide/server )
- š¦ [Builder]( https://backan.pigeonposse.com/guide/builder )
- [Installation](https://backan.pigeonposse.com/guide/core/#installation)
<!-- PIGEONPOSSE END INDEX -->
<!-- PIGEONPOSSE START ORG -->
## šØāš» Development
**BACKAN** is an open-source project and its development is open to anyone who wants to participate.
[](https://github.com/pigeonposse/backan/issues)
[](https://github.com/pigeonposse/backan/pulls)
[](https://backan.pigeonposse.com/)
## ā Donate
Help us to develop more interesting things.
[](https://pigeonposse.com/?popup=donate)
## š License
This software is licensed with **[GPL-3.0](/LICENSE)**.
[](/LICENSE)
## š¦ 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.
[](https://github.com/pigeonposse)
### Collaborators
| | Name | Role | GitHub |
| ---------------------------------------------------------------------------------- | ----------- | ------------ | ---------------------------------------------- |
| <img src="https://github.com/angelespejo.png?size=72" alt="Angelo" style="border-radius:100%"/> | Angelo | Author & Development | [@Angelo](https://github.com/angelespejo) |
| <img src="https://github.com/PigeonPosse.png?size=72" alt="PigeonPosse" style="border-radius:100%"/> | PigeonPosse | Collective | [@PigeonPosse](https://github.com/PigeonPosse) |
<br>
<p align="center">
[](https://pigeonposse.com)
[](https://pigeonposse.com?popup=about)
[](https://pigeonposse.com/?popup=donate)
[](https://github.com/pigeonposse)
[](https://twitter.com/pigeonposse_)
[](https://www.instagram.com/pigeon.posse/)
[](https://medium.com/@pigeonposse)
</p>
<!-- PIGEONPOSSE END ORG -->
<!-- PIGEONPOSSE START MARK -->
<!--
āāāāāāā āāā āāāāāāā āāāāāāāā āāāāāāā āāāā āāā
āāāāāāāāāāāāāāāāāāā āāāāāāāāāāāāāāāāāāāāāā āāā
āāāāāāāāāāāāāā āāāāāāāāāā āāā āāāāāāāāā āāā
āāāāāāā āāāāāā āāāāāāāāā āāā āāāāāāāāāāāāā
āāā āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā āāāāāā
āāā āāā āāāāāāā āāāāāāāā āāāāāāā āāā āāāāā
āāāāāāā āāāāāāā āāāāāāāāāāāāāāāāāāāāāāāā
āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā
āāāāāāāāāāā āāāāāāāāāāāāāāāāāāāāāāāāā
āāāāāāā āāā āāāāāāāāāāāāāāāāāāāāāāāāā
āāā āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā
āāā āāāāāāā āāāāāāāāāāāāāāāāāāāāāāāā
āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā
āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā
āāāāāāā āāāāāā āāāāāāāāāā āāā āāāāāā āāāā āāā
āāāāāāāāāāāāāāāāāāāāāāāāāāā āāāāāāāāāāāāāāāāā āāā
āāāāāāāāāāāāāāāāāāā āāāāāāā āāāāāāāāāāāāāā āāā
āāāāāāāāāāāāāāāāāāā āāāāāāā āāāāāāāāāāāāāāāāāā
āāāāāāāāāāā āāāāāāāāāāāāāā āāāāāā āāāāāā āāāāāā
āāāāāāā āāā āāā āāāāāāāāāā āāāāāā āāāāāā āāāāā
REPOSITORY: https://github.com/pigeonposse/backan
AUTHORS:
- Angelo (https://github.com/angelespejo)
DEVELOPED BY Angelo š¦š
-->
<!-- PIGEONPOSSE END MARK -->