Service Framework

Architecture

Folder Structure

```text
src/
├── config/           # code that parses environment variables and 
|                       exports a configuration object to the rest 
|                       of the codebase.
|
├── middlewares/     # middlewares for Express
|
├── index.ts         # Application entry point
|
├── routes/           # top-level files default export a Router
|                       object describing the routes to serve.
|                       Note: the routers are loaded and served 
|                       automatically using the file name!
|
├── services/        # any logic, low-level (e.g. cache) or business logic
|   ├── constants/
|   ├── models/
|   ├── repositories/
|   ├── utils/
|   └── types/
|
├── constants/        # any constant values and enums   
|
├── models/          # data models and interfaces
|
├── repositories/    # data access layer
|
├── utils/           # utility functions
|
└── types/           # global type definitions
```

Testing

Test infrastructure is currently being implemented: using Jest with ts-jest package

Recommended IDE Settings (VS Code)

```json
{
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
},
"typescript.updateImportsOnFileMove.enabled": "always",
"typescript.preferences.importModuleSpecifier": "relative"
}
```