README
¶
Purpose
The Doc Box is a serverless application that implements the business capabilities of the business domain Document Management.
Currently, the following business capabilities are supported:
- Create Document-Metadata and add Attachments
Project structure
The project contains of source code and files for a serverless application that can be deployed via AWS CDK. See deploy/cdk/README.md for build of the AWS CDK project.
| Folder | Description |
|---|---|
| doc-box | Root folder for building, testing, etc. |
| doc-box/cnd | Contains the handlers for the implemented serverless functions. |
| doc-box/deploy | Contains the AWS CDK stack, local test infrastructure (localstack) and needed tools. |
| doc-box/doc | Contains the specification and documentation. |
| doc-box/pkg | Contains the internal source code for the implemented serverless functions. |
| doc-box/pkg/tmf | Contains the generated tmf api model. |
Requirements
- Unix System environment
- Configured AWS CLI with administrator permissions
- Docker installed
- Golang
- Node.js
- Yarn - Package Manager
Getting Started
Installing dependencies & building the target
The used build management tool is Make, all Make commands are executed in the root folder.
Installing build tools (initial)
Before build, the tools go-impi and golangci-lint must be installed.
With the following command the tools can be installed
$ make install-tools
Building the target
Complete Build of Golang project via Makefile
$ make
Directories
Click to show internal directories.
Click to hide internal directories.