go/golang-saas-starter-kit
1
0
Fork 0
mirror of https://github.com/raseels-repos/golang-saas-starter-kit.git synced 2025-06-04 23:37:49 +02:00
Code Issues Releases Activity

Adding new section to readme for setting up new project

Browse Source
This commit is contained in:
Lee Brown 2019-08-12 17:39:03 -08:00
parent e180e05c9b
commit 2c4331d1d0
2 changed files with 106 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

103
README.md
View File

@ -304,6 +304,109 @@ $ go run main.go
```
### Forking your own copy
1. Checkout the project
2. Update references.
```bash
flist=`grep -r "geeks-accelerator/oss/saas-starter-kit" * | awk -F ':' '{print $1}' | sort | uniq`
for f in $flist; do echo $f; sed -i "" -e "s#geeks-accelerator/oss/saas-starter-kit#geeks-accelerator/oss/aurora-cam#g" $f; done
flist=`grep -r "saas-starter-kit" * | awk -F ':' '{print $1}' | sort | uniq`
for f in $flist; do echo $f; sed -i "" -e "s#saas-starter-kit#aurora-cam#g" $f; done
```
3. Create a new AWS Policy with the following details:
```
Name: SaasStarterKitDevServices
Description: Defines access for saas-starter-kit services.
Policy Document: {
"Version": "2012-10-17",
"Statement": [
{
"Sid": "DefaultServiceAccess",
"Effect": "Allow",
"Action": [
"s3:HeadBucket",
"s3:ListObjects",
"s3:PutObject",
"s3:PutObjectAcl",
"cloudfront:ListDistributions",
"ec2:DescribeNetworkInterfaces",
"ec2:DeleteNetworkInterface",
"ecs:ListTasks",
"ecs:DescribeServices",
"ecs:DescribeTasks",
"ec2:DescribeNetworkInterfaces",
"route53:ListHostedZones",
"route53:ListResourceRecordSets",
"route53:ChangeResourceRecordSets",
"ecs:UpdateService",
"ses:SendEmail",
"ses:ListIdentities",
"ses:GetAccountSendingEnabled",
"secretsmanager:ListSecretVersionIds",
"secretsmanager:GetSecretValue",
"secretsmanager:CreateSecret",
"secretsmanager:UpdateSecret",
"secretsmanager:RestoreSecret",
"secretsmanager:DeleteSecret"
],
"Resource": "*"
},
{
"Sid": "ServiceInvokeLambda",
"Effect": "Allow",
"Action": [
"iam:GetRole",
"lambda:InvokeFunction",
"lambda:ListVersionsByFunction",
"lambda:GetFunction",
"lambda:InvokeAsync",
"lambda:GetFunctionConfiguration",
"iam:PassRole",
"lambda:GetAlias",
"lambda:GetPolicy"
],
"Resource": [
"arn:aws:iam:::role/*",
"arn:aws:lambda:::function:*"
]
},
{
"Sid": "datadoglambda",
"Effect": "Allow",
"Action": [
"cloudwatch:Get*",
"cloudwatch:List*",
"ec2:Describe*",
"support:*",
"tag:GetResources",
"tag:GetTagKeys",
"tag:GetTagValues"
],
"Resource": "*"
}
]
}
```
Create a new user with programic access and directly attach it the policy `SaasStarterKitDevServices`
4. Create a new docker-compose config file
```bash
cp sample.env_docker_compose .env_docker_compose
```
5. Update .env_docker_compose with the Access key ID and Secret access key
6. Update `.gitlab-ci.yml` with relevent details.
### Optional. Set AWS and Datadog Configs
By default the project will compile and run without AWS configs or other third-party dependencies.

4
sample.env_docker_compose
View File

@ -2,4 +2,6 @@
#AWS_SECRET_ACCESS_KEY=
#AWS_REGION=us-west-2
#AWS_USE_ROLE=false
#DD_API_KEY=
#DD_API_KEY=
#WEB_APP_AWS_S3_BUCKET_PRIVATE=
#WEB_APP_AWS_S3_BUCKET_PUBLIC=