Skip to content

Enterprise-CMCS/macpro-quickstart-serverless-support

Repository files navigation

macpro-quickstart-serverless-support

A support repository for macpro-quickstart-serverless. This repository builds appliances and systems that support the macpro-quickstart-serverless product, but are not directly related to the application and/or are not bound to the application code's lifecycle. Things of this nature are frequently centered on AWS account level maintenance and configuration.

Release

Our product is promoted through branches. Master is merged to val to affect a master release, and val is merged to production to affect a production release. Please use the buttons below to promote/release code to higher environments.

** The quickstart only has one backing AWS account, so master/val/production all deploy to the same account. As such, there is no need for promotion in the support repository. The master branch will control the one and only AWS account. However, since forks of this project will likely support 3 AWS accounts - one for master/dev, one for val, and one for production - this blurb about release, the table below, and the pull request templates for val/production will all remain. We simply won't use val/production branches or tooling for this support repository, because we only have the one account.

branch status release
master master release to master
val val release to val
production production release to production

Usage

See master build here

This application is built and deployed via GitHub Actions.

Want to deploy from your Mac? Well, word of warning... this repository contains things and ideas that are typically bound to an account, not a stage. So if deploying a stage (mystagename for example), you may well step on another stage if you're both deploying to the same AWS account. If that's confusing, don't deploy from your mac.

  • Create an AWS account
  • Install/configure the AWS CLI
  • brew install yarn
  • source set.env.sh
  • sh deploy.sh mystagename

Requirements

Node - we enforce using a specific version of node, specified in the file .nvmrc. This version matches the Lambda runtime. We recommend managing node versions using NVM.

Serverless - Get help installing it here: Serverless Getting Started page

Yarn - in order to install dependencies, you need to install yarn.

AWS Account: You'll need an AWS account with appropriate IAM permissions (admin recommended) to deploy this app in Amazon.

Dependencies

None.

Examples

None.

Contributing / To-Do

See current open issues or check out the project board.

Please feel free to open new issues for defects or enhancements.

To contribute:

  • Fork this repository
  • Make changes in your fork
  • Open a pull request targeting this repository

Pull requests are being accepted.

License

License

See LICENSE for full details.

As a work of the United States Government, this project is
in the public domain within the United States.

Additionally, we waive copyright and related rights in the
work worldwide through the CC0 1.0 Universal public domain dedication.

Contributors

Mike Dial
Mike Dial

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published