Skip to content

Commit

Permalink
Merge pull request #26 from fabrix-app/v1.5
Browse files Browse the repository at this point in the history
[fix] archetype
  • Loading branch information
scott-wyatt authored Sep 29, 2018
2 parents 5d94525 + 6a04471 commit 3de2a53
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 7 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,21 @@ Fabrix is a strongly typed modern web application framework for Node.js. It buil
## Getting Started

#### Install
The Fabrix CLI is still under development so the following is a placeholder.
Install the Fabrix CLI. This will help you generate a Fabrix app and more quickly.

```sh
$ npm install @fabrix/fab-cli
$ npm install @fabrix/fab-cli -g
```

#### Generate A New Fabrix App
```sh
$ fab app <new_app_name>
```

#### Start Sewing

Fabrix uses a CLI to generate scaffolding for new
applications, and to create resources inside the application. (TODO)
applications, and to create resources inside the application.

```sh
$ fab --help
Expand All @@ -30,6 +35,8 @@ Usage:
fab

Generators:
Create New App
fab app <app-name>

Create New Model
fab model <model-name>
Expand All @@ -51,7 +58,7 @@ Generators:

Once installation is complete, begin weaving!
```sh
$ npm run build && node dist/server.js
$ npm run compile && node dist/server.js
```

#### Sew on and Sew Forth!
Expand Down
4 changes: 3 additions & 1 deletion archetype/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@
"watch": "tsc -w -p ./src/tsconfig.release.json",
"test": "npm run clean && npm run lint && npm run build && nyc mocha",
"prepublishOnly": "npm run compile",
"compile": "npm run clean && npm run build",
"compile": "npm run clean && npm run build && npm run copy",
"copy": "copyfiles -u 1 src/**/*.json dist",
"clean": "rm -rf dist"
},
"main": "dist/index.js",
Expand All @@ -22,6 +23,7 @@
"@fabrix/spool-repl": "^1.5",
"@fabrix/lint": "^1.0.0-alpha.3",
"@types/node": "~10.3.4",
"copyfiles": "^2.0.0",
"mocha": "^5",
"nyc": "^13.0.1",
"supertest": "^3",
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@fabrix/fabrix",
"version": "1.5.7",
"version": "1.5.8",
"description": "Strongly Typed Modern Web Application Framework for Node.js",
"keywords": [
"framework",
Expand Down

0 comments on commit 3de2a53

Please sign in to comment.