generator-valory

Description

This yeoman generator will output a boilerplate valory TS project based on a given swagger json file.

Project Structure / Guidelines

├── src                 <─ This folder contains all source code
│   ├── appserver.ts    <─ Main entry point
│   ├── cluster.ts      <─ Starts listener cluster
│   ├── endpoints       <─ This folder contains all endpoints
│   │   └── ... 
│   │── middleware      <─ This folder contains all middleware
│   │   └── ... 
│   └── lib             <─ This folder contains libraries
│       ├── app         <─ This folder is for app specific libraries
│       │   └── ... 
│       ├── config.ts   <─ Reads in config values
│       └── service.ts  <─ Exports app singletons, including config
├── package.json
├── config.json         <─ Stores config structure and defaults
├── tsconfig.json       
└── tslint.json

src/lib/service.ts

This is where you should put all shared instances (and only instances; do not re-export app specific modules) for the app. The type interface for the config also lives here.

src/endpoints

Endpoints should be grouped by common path in files placed in this folder. The endpoint files should export nothing, and should contain nothing but endpoints.

src/middleware

Only middleware class files should be places in this folder. Literal middlewares should not be placed here, but instead be placed as close to where they are used as possible.

src/appserver.ts

This is the main entrypoint. When you add a new endpoint file, you'll have to add it here. Global middleware should also be registered here.

config.json

This files stores your config structure with defaults. The config interface defined in the service file (src/lib/service.ts) should match this file.