nork/README.md

38 lines
1.2 KiB
Markdown
Raw Normal View History

2021-08-15 20:38:31 +02:00
# Nork
Simple node.js tool that extends express projects.
- [About](#about)
- [Installation](#installation)
- [How to use](#how-to-use)
2021-08-14 15:55:17 +02:00
## About
2021-08-15 20:41:22 +02:00
The point of this tool is to add to express some feeling of php framework Laravel. Primarily get simply express app into MVC architecture.
2021-08-14 15:55:17 +02:00
## Installation
2021-08-15 20:38:31 +02:00
```
npm install -g nork
```
2021-08-15 20:41:22 +02:00
This will install nork globally. If you would like to install nork for only one project, you can also install it locally. For local installation:
2021-08-15 20:38:31 +02:00
```
npm install nork
```
2021-08-14 15:55:17 +02:00
## How to use
2021-08-15 20:38:31 +02:00
```
Usage: nork <command> [options]
2021-08-14 15:55:17 +02:00
2021-08-15 20:38:31 +02:00
Options:
2021-08-15 20:48:10 +02:00
-v, --version output the version number
-h, --help output usage information
2021-08-14 15:55:17 +02:00
2021-08-15 20:38:31 +02:00
Commands:
2021-08-15 20:48:10 +02:00
create [app-name] create a new project
2021-08-19 16:17:18 +02:00
create [app-name] -i create a new project in current directory
2021-08-18 11:46:54 +02:00
make controller [name] create a new controller
make middleware [name] create a new middleware
make model [name] create a new model
2021-08-19 11:16:17 +02:00
make route [name] create a new route
2021-08-18 11:46:54 +02:00
make test [name] create a new test
make view [name] create a new view
2021-08-15 20:48:10 +02:00
setup set up an existing project for nork
2021-08-15 20:38:31 +02:00
```