https://github.com/liftr-framework/cli

The liftr-cli is a quick project-starter and component generation CLI to work with the Liftr framework
https://github.com/liftr-framework/cli

api cli express framework liftr liftr-framework typescript

Last synced: 3 days ago
JSON representation

The liftr-cli is a quick project-starter and component generation CLI to work with the Liftr framework

• Host: GitHub
• URL: https://github.com/liftr-framework/cli
• Owner: liftr-framework
• License: mit
• Created: 2019-02-19T15:57:07.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-05-26T13:22:47.000Z (over 4 years ago)
• Last Synced: 2024-10-29T23:15:03.970Z (16 days ago)
• Topics: api, cli, express, framework, liftr, liftr-framework, typescript
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@liftr/cli
• Size: 197 KB
• Stars: 19
• Watchers: 2
• Forks: 2
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# liftr-cli



    



[![npmversion](https://img.shields.io/npm/v/@liftr/cli.svg?style=for-the-badge)](https://github.com/liftr-framework/cli)

[![npmlicense](https://img.shields.io/npm/l/@liftr/cli.svg?style=for-the-badge)](https://github.com/liftr-framework/cli/blob/master/LICENSE/)

[![downloads](https://img.shields.io/npm/dy/liftr.svg?style=for-the-badge)](https://github.com/liftr-framework/cli)

The liftr-cli is a quick project-starter CLI to work with the Liftr framework, it will create the necessary files for you to begin a Node.js & Typescript project. Ontop of that, you can generate new backend components on the fly - providing a quicker way to build structured and robust API's.

## Quickstart

Install the liftr-cli as a global CLI.

```shell

npm install -g @liftr/cli

cd 

# Then you run

liftr create setup

```

This should setup a project with all the necessary folders and files so that you can begin building straight away!

### Commands

Here are all the possibilities with the liftr-cli

```shell

# Create a setup for your Nodejs/Typescript project

liftr create setup

# THE FOLLOWING COMMANDS CAN ONLY BE DONE IN A LIFTR SETUP

-----------------------------------------------------------

# All files get their own folder in their component folder

# Create a module with its own routes file which provides. The module gets added to the LiftrRoutingModule

liftr create module

# Create a route in a target route file as well as in the target module (should have the same intial name). This will add the route to the routes file and automatically add it to the module.

liftr create route

# Create a controller in the controller folder

liftr create controller

# Create a middleware in the middleware folder

liftr create middleware

```

## Supporting packages

| Package | Description | Version |

| --- | --- | --- |

| [@liftr/core](https://github.com/liftr-framework/core) | The core package for Liftr | [![npmversion](https://img.shields.io/npm/v/@liftr/core.svg?style=for-the-badge)](https://github.com/liftr-framework/core) |

| [@liftr/tscov](https://github.com/jeroenouw/liftr-tscov) | Check the type coverage of your Liftr project TypeScript project | [![npmversion](https://img.shields.io/npm/v/@liftr/tscov.svg?style=for-the-badge)](https://github.com/jeroenouw/liftr-tscov) |

## Contributing

Want to file a bug, contribute some code, or improve documentation? Feel free to place an [issue](https://github.com/liftr-framework/cli/issues) and check the [contributing guidelines](https://github.com/liftr-framework/cli/blob/master/CONTRIBUTING.md/).