Note: The documentation is a work in progress. It will be in a much better state in couple of days!
The primary objective of this boilerplate is to give you a production ready code that reduces the amount of time you would normally have to spend on system infrastructure's configuration. It contains a number of services that a typical web application has (frontend, backend api, admin panel, workers) as well as their continuous deployment. Using this boilerplate you can deploy multiple environments, each representing a different stage in your pipeline.
We don't create any new CLIs or APIs that you need to learn. We use existing solutions, which you can extend or change however you like:
Install latest Node.js (with NPM >= 6)
Install Python 3.8
We recommend installing Python using
Install AWS CLI version 2
We recommend cloning this repository instead of downloading the ZIP. This way you'll be able to merge latest changes without too much hassle by resolving conflicts using your favourite tools.
To setup the project and install local dependencies run following command:
Run backend services:
Backend is running on
Admin Panel is running on
Workers do not expose any http address.
Check out our deployment to AWS documentation
The boilerplate contains a number of typical services that are ready to be deployed to AWS.
Each of them resides in the
services directory and has to contain a
Makefile. Do not change the names of the rules
that are defined in Makefiles unless you know what you're doing. Most of them are used in CodeBuild jobs in your CI
Each deployed environment comes with a preconfigured CI/CD implemented with AWS CodeCommit, AWS CodeBuild,
and AWS CodePipeline. The general idea of deployment is for the user to push code to a
master branch of the CodeCommit
repository created by the Ci CDK Stack.
Check out the CI/CD documentation to learn more.