# generate-node-project

> Set up NodeJS REST app by running one command.

Latest version **1.2.0** (published 2022-07-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install generate-node-project
pnpm add generate-node-project
yarn add generate-node-project
bun add generate-node-project
```

Provides the commands `create-node-api`, `generate-node-project`.

## 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 | 1.2.0 |
| Published | 2022-07-05 |
| First published | 2019-11-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 38.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 13 |
| Author | luc.bayo@gmail.com |
| Maintainers | abayo-luc |
| Keywords | CLI, NodeJS, Boilerplate |

## Links

- npm: https://www.npmjs.com/package/generate-node-project
- Repository: https://github.com/abayo-luc/generate-node-project
- Homepage: http://git@github.com:abayo-luc/generate-node-project#readme
- npm.io page: https://npm.io/package/generate-node-project

## Dependencies (7)

- [ncp](https://npm.io/package/ncp.md) 2.0.0
- [chalk](https://npm.io/package/chalk.md) 4.1.0
- [listr](https://npm.io/package/listr.md) 0.14.3
- [yargs](https://npm.io/package/yargs.md) 16.2.0
- [depcheck](https://npm.io/package/depcheck.md) 1.4.2
- [inquirer](https://npm.io/package/inquirer.md) 7.3.3
- [node-emoji](https://npm.io/package/node-emoji.md) 1.10.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.2.0 (latest) — 2022-07-05
- 1.1.0 — 2022-07-04
- 1.0.91 — 2022-07-04
- 1.0.9 — 2020-12-08
- 1.0.8 — 2020-08-12
- 1.0.7 — 2020-03-04
- 1.0.6 — 2020-02-06
- 1.0.5 — 2020-02-06
- 1.0.4 — 2020-02-05
- 1.0.3 — 2019-11-27
- 1.0.2 — 2019-11-26
- 1.0.1 — 2019-11-25
- 1.0.0 — 2019-11-21

## README

[![wakatime](https://wakatime.com/badge/github/abayo-luc/generate-node-project.svg)](https://wakatime.com/badge/github/abayo-luc/generate-node-project)

# generate-node-project

Generate a complete NodeJS app (API) with babel, jest, Sequelize, JWT already configured for you.

- [Creating an App](#creating-an-app) – How to create a new app.

Generate Node Project works on macOS, Windows, and Linux.<br>
If something doesn’t work, please [file an issue](https://github.com/abayo-luc/generate-node-project/issues/new).<br>
If you have questions or need help, please ask via email: luc.bayo@gmail.com

## Installation

```sh
npm i -g generate-node-project
```

or

```sh
yarn global add generate-node-project
```

## Quick Overview

```sh
generate-node-project new_node
cd new_node
npm start
```

### Get Started Immediately

You **don’t** need to install or configure tools like babel, eslint, sequelize, jest, mocha, mongodb, etc....<br>
They are pre-configured and working, so that you can focus on the code.

Create a project, and you’re good to go.

## Creating an App

**You’ll need to have Node 8.16.0 or Node 10.16.0 or later version on your local development machine**

To create a new app, you may choose one of the following methods:

### generate-node-project

```sh
generate-node-project new_node
```

### OR create-node-api

```sh
create-node-api new_node
```

It will create a directory called `new_node` inside the current folder.<br>
Inside that directory, it will generate the initial project structure and install the required dependencies:

```
new_node
├── README.md
├── node_modules
├── package.json
├── .gitignore
├── .eslintrc
├── .jest.config.js
├── .env
├── app.js
├── index.js
├── __tests__
└── src
    ├── config
    ├── controllers
    ├── routes
    ├── models
    ├── migrations
    └── seeders
```

Now all the configurations and folder structures are done for you.<br>
Once the installation is done, you can open your project folder:

```sh
cd new_node
```

Inside the newly created project, you can run some existing commands:

### `npm start` or `yarn start`

Runs the app in development mode.<br>
And it will be available on [http://localhost:3000](http://localhost:3000).

### `npm test` or `yarn test`

Runs the test.<br>

## More Commands:

Generate basic NodeJs API: javascript

```sh
generate-node-project app_name --skip
```

Generate basic NodeJs API: typscript

```sh
generate-node-project app_name --template=typescript
```

View all available commands

```sh
generate-node-project --help
```

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