@travetto/scaffold 3.0.3-rc.1 → 3.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -12
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
<!-- This file was generated by @travetto/doc and should not be modified directly -->
|
|
2
|
-
<!-- Please modify https://github.com/travetto/travetto/tree/main/module/scaffold/DOC.
|
|
2
|
+
<!-- Please modify https://github.com/travetto/travetto/tree/main/module/scaffold/DOC.tsx and execute "npx trv doc" to rebuild -->
|
|
3
3
|
# App Scaffold
|
|
4
|
+
|
|
4
5
|
## App Scaffold for the Travetto framework
|
|
5
6
|
|
|
6
7
|
A simple tool for scaffolding a reference project. To get started, you need to make sure:
|
|
7
8
|
|
|
8
|
-
**
|
|
9
|
+
**Terminal: Setting up the necessary config**
|
|
9
10
|
```bash
|
|
10
11
|
$ git config --global.username <Username> #Set your git username
|
|
11
12
|
```
|
|
@@ -25,18 +26,15 @@ The generator will ask about enabling the following features:
|
|
|
25
26
|
|
|
26
27
|
## Restful Architecture
|
|
27
28
|
The [RESTful API](https://github.com/travetto/travetto/tree/main/module/rest#readme "Declarative api for RESTful APIs with support for the dependency injection module.") provides the necessary integration for exposing restful apis. When selecting the `rest` feature, you will need to specify which backend you want to include with your application, the default being [express](https://expressjs.com). Currently you can select from:
|
|
28
|
-
|
|
29
|
-
|
|
30
29
|
* [express](https://expressjs.com)
|
|
31
30
|
* [koa](https://koajs.com/)
|
|
32
31
|
* [fastify](https://www.fastify.io/)
|
|
33
|
-
|
|
34
|
-
The code will establish some basic routes, specifically, `GET /` as the root endpoint. This will return the contents of your `package.json` as an identification operation.
|
|
32
|
+
The code will establish some basic routes, specifically, `GET / ` as the root endpoint. This will return the contents of your `package.json` as an identification operation.
|
|
35
33
|
|
|
36
34
|
### Additional Rest Features
|
|
37
35
|
In addition to the core functionality, the `rest` feature has some useful sub-features. Specifically:
|
|
38
36
|
|
|
39
|
-
[OpenAPI Specification](https://github.com/travetto/travetto/tree/main/module/openapi#readme "OpenAPI integration support for the Travetto framework") support for the restful api. This will automatically expose a `openapi.yml` endpoint, and provide the necessary plumbing to support client generation.
|
|
37
|
+
[OpenAPI Specification](https://github.com/travetto/travetto/tree/main/module/openapi#readme "OpenAPI integration support for the Travetto framework") support for the restful api. This will automatically expose a `openapi.yml` endpoint, and provide the necessary plumbing to support client generation.
|
|
40
38
|
|
|
41
39
|
[Logging](https://github.com/travetto/travetto/tree/main/module/log#readme "Logging framework that integrates at the console.log level.") support for better formatting, [debug](https://www.npmjs.com/package/debug) like support, and colorized output. This is generally useful for server logs, especially during development.
|
|
42
40
|
|
|
@@ -47,16 +45,12 @@ Authentication is also supported on the Restful endpoints by selecting [Rest Aut
|
|
|
47
45
|
[Testing](https://github.com/travetto/travetto/tree/main/module/test#readme "Declarative test framework") can also be configured out of the box to provide simple test cases for the data model.
|
|
48
46
|
|
|
49
47
|
## Data Modelling and Storage
|
|
50
|
-
|
|
51
48
|
The [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") allows for modeling of application data, and provides mechanisms for storage and retrieval. When setting up your application, you will need to select which database backend you want to use:
|
|
52
|
-
|
|
53
|
-
|
|
54
49
|
* [elasticsearch](https://elastic.co)
|
|
55
50
|
* [mongodb](https://mongodb.com)
|
|
56
51
|
* [SQL](https://en.wikipedia.org/wiki/SQL)
|
|
57
52
|
* [DynamoDB](https://aws.amazon.com/dynamodb/)
|
|
58
53
|
* [Firestore](https://firebase.google.com/docs/firestore)
|
|
59
|
-
|
|
60
54
|
A default model is constructed, a [Todo](https://github.com/travetto/travetto/tree/main/module/scaffold/doc/model.ts#L4) class:
|
|
61
55
|
|
|
62
56
|
**Code: Todo Model**
|
|
@@ -152,7 +146,6 @@ export class TodoController {
|
|
|
152
146
|
```
|
|
153
147
|
|
|
154
148
|
## Running
|
|
155
|
-
|
|
156
149
|
Once finished the application will reflect the modules chosen, and will be ready for execution, if you have configured a runnable application. Currently, this requires the `rest` feature to be selected.
|
|
157
150
|
|
|
158
151
|
**Terminal: Starting the App**
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@travetto/scaffold",
|
|
3
|
-
"version": "3.0.
|
|
3
|
+
"version": "3.0.4",
|
|
4
4
|
"description": "App Scaffold for the Travetto framework",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"generator",
|
|
@@ -27,9 +27,9 @@
|
|
|
27
27
|
"trv-scaffold": "./bin/trv-scaffold.js"
|
|
28
28
|
},
|
|
29
29
|
"dependencies": {
|
|
30
|
-
"@travetto/base": "^3.0.
|
|
31
|
-
"@travetto/compiler": "^3.0.
|
|
32
|
-
"@travetto/cli": "^3.0.
|
|
30
|
+
"@travetto/base": "^3.0.3",
|
|
31
|
+
"@travetto/compiler": "^3.0.3",
|
|
32
|
+
"@travetto/cli": "^3.0.3",
|
|
33
33
|
"enquirer": "^2.3.6",
|
|
34
34
|
"mustache": "^4.2.0"
|
|
35
35
|
},
|