# create-backend

> A CLI built in Node.js, to automate the process of creating a rest api / sockets backend basics

Latest version **3.9.5** (published 2019-12-10) · GNU V3 license · 0 weekly downloads

## Install

```sh
npm install create-backend
pnpm add create-backend
yarn add create-backend
bun add create-backend
```

Provides the command `create-backend`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.9.5 |
| Published | 2019-12-10 |
| First published | 2019-09-30 |
| Weekly downloads | 0 |
| License | GNU V3 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 181.9 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 11 |
| Author | ChoqueCastroLD |
| Maintainers | shokocc |
| Keywords | create-backend, cli, generator, scaffolding, Mongodb, sequelize, mysql, tool, npx, create backend, automatic, generate |

## Links

- npm: https://www.npmjs.com/package/create-backend
- Repository: https://github.com/ChoqueCastroLD/create-backend
- Homepage: https://github.com/ChoqueCastroLD/create-backend#readme
- Issues: https://github.com/ChoqueCastroLD/create-backend/issues
- npm.io page: https://npm.io/package/create-backend

## Dependencies (3)

- [ejs](https://npm.io/package/ejs.md) ^2.7.4
- [inquirer](https://npm.io/package/inquirer.md) ^7.0.0
- [minimist](https://npm.io/package/minimist.md) ^1.2.0

## Alternatives

- [angular-pipes](https://npm.io/package/angular-pipes.md) — 5.6K weekly downloads
- [@ng-web-apis/midi](https://npm.io/package/@ng-web-apis/midi.md) — 2.6K weekly downloads
- [happn-3](https://npm.io/package/happn-3.md) — 1.6K weekly downloads
- [@opensip-cli/lang-go](https://npm.io/package/@opensip-cli/lang-go.md) — 1.2K weekly downloads
- [@temporal-architect/claude-plugin](https://npm.io/package/@temporal-architect/claude-plugin.md) — 335 weekly downloads

## Recent versions

- 3.9.5 (latest) — 2019-12-10
- 3.9.4 — 2019-12-09
- 3.9.3 — 2019-12-06
- 3.8.6 — 2019-11-26
- 3.8.5 — 2019-11-26
- 3.8.4 — 2019-11-26
- 3.8.3 — 2019-11-21
- 3.8.2 — 2019-11-21
- 3.8.1 — 2019-11-21
- 3.8.0 — 2019-11-21
- 3.7.1 — 2019-11-21
- 3.7.0 — 2019-11-21
- 3.6.9 — 2019-11-21
- 3.6.8 — 2019-11-21
- 3.6.7 — 2019-11-21
- … 37 more at https://npm.io/package/create-backend/versions

## README

# create-backend
A CLI built in Node.js, to automate the process of creating a rest api / sockets backend basics


## Features

✓ Support for ¡*MongoDb* and Mysql!

✓ Sequelize(Mysql, Postgre, Microsoft Sql, Mariadb) Support

✓ Mysqlm support (Promise Query Streams)

✓ Morgan logger with log folder

✓ Fully ready-to-use Typescript and Vanilla Javascript support

✓ More than 35 Licenses

✓ Express Ready for Promises (Async / Await)

✓ Module Aliases support

✓ Example Endpoint

✓ Fully configured enviroment variables

✓ Production ready

✓ Bulletproof Folder Structure

## Usage

Use directly with npx (npx comes installed with npm)
```sh
npx create-backend
```
Then you just answer some prompts and *boom!* you got a backend.

## Advanced Usage

###### Command Arguments
Argument | Values | Default | Description
--- | --- | --- | ---
**-y** | *none* | *none* | Skip all prompts
**--name** | :String | 'generated_backend' | Project Name
**--db** | *mysql* or *mariadb* or *mssql* or *postgres* or *mysql_ns* (No Sequelize) | *mysql_ns* (No Sequelize) | Database engine to be used
**--example** | *none* | *none* | Adds an example endpoint
**-ts** | *none* | *none* | Use Typescript instead on Vanilla Javascript
**--aliases** | *none* | *none* | Use Aliases for Modules require's
**--license** | see licenses.js | 'UNLICENSED' | Which license will be used
**--port** | :Number | 3000 | Which license will be used

## Examples

Create project named naza_backend
> $ npx create-backend naza_backend

using typescript
> $ npx create-backend naza_backend -ts

using typescript and postgressql
> $ npx create-backend naza_backend --db=postgres

using javascript and mariadb
> $ npx create-backend naza_backend --db=mariadb


## TODO
1. [ ] Testing (Jest, Mocha)
2. [ ] Microservices (Using cota, not so soon)
3. [ ] Generate backend based on .sql script (model and controllers)
4. [x] MongoDb support
5. [ ] Joi for schema validation (Probably not)
6. [x] Express custom error handling

---
Screenshot:

![Alt text](/ss.png?raw=true "screen")

---
_Source: https://npm.io/package/create-backend · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._