Skip to content

Commit

Permalink
Merge pull request #1647 from flexion/pull_in_court_changes_sprint_13
Browse files Browse the repository at this point in the history
Pull in court changes sprint 13
  • Loading branch information
codyseibert authored May 8, 2019

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
2 parents de36e73 + 024f3fd commit 62ae9b0
Showing 4 changed files with 29 additions and 28 deletions.
57 changes: 29 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -8,7 +8,7 @@

#### staging

[![CircleCI](https://circleci.com/gh/usataxcourt/ef-cms/tree/staging.svg?style=svg)](https://circleci.com/gh/usataxcourt/ef-cms/tree/staging)
[![CircleCI](https://circleci.com/gh/ustaxcourt/ef-cms/tree/staging.svg?style=svg)](https://circleci.com/gh/ustaxcourt/ef-cms/tree/staging)

API | Front-End | Shared Code
--- | --------- | -----------
@@ -61,12 +61,12 @@ Assuming you have Docker installed, the following command will spin up a Docker

`./docker-run.sh`

You can access the UI at http://localhost:1234
You can access the API at http://localhost:3000
You can access the dynamodb shell at http://localhost:8000/shell
You can access the dynamodb-admin ui at http://localhost:8001
You can access s3 local at http://localhost:9000
You can access the style guide at http://localhost:1234/style-guide
- You can access the UI at http://localhost:1234
- You can access the API at http://localhost:3000
- You can access the dynamodb shell at http://localhost:8000/shell
- You can access the dynamodb-admin ui at http://localhost:8001
- You can access s3 local at http://localhost:9000
- You can access the style guide at http://localhost:1234/style-guide

## Running this project locally without Docker

@@ -188,11 +188,12 @@ Follow these steps for creating the end of sprint PRs for the court.

## Prerequisites
- [Create an AWS account](https://portal.aws.amazon.com/gp/aws/developer/registration/).
- In [AWS Identity and Access Management](https://console.aws.amazon.com/iam/), create a `CircleCI` user:
- Run the `generate-policy.sh YOUR_ACCOUNT_ID_AS_ARG_1` to generated the policy.json.
- Create a IAM policy called CircleCIPolicy with that generated policy.json
- Create the CircleCI user and attach the policy
- keep track of the access key and secret access key; it is needed for the CircleCI setup.
- Create a `CircleCI` user in [AWS Identity and Access Management](https://console.aws.amazon.com/iam/):
- Determine your organization’s AWS ID, a 12-digit number. While logged into the AWS Console, you can find this in the account menu in the top right, where it may appear with hyphens, e.g. `3503-6506-1526`.
- In your local copy of the repository, generate an IAM policy with `./generate-policy.sh [YOUR_ACCOUNT_ID]`, e.g. `generate-policy.sh 350365061526`.
- Create a IAM policy called `CircleCIPolicy`, populating it with the contents of the generated `policy.json`.
- Create the `CircleCI` user and attach the policy.
- Keep track of the access key and secret access key — it is needed for the CircleCI setup.
- [Create a Route53 Hosted Zone](https://console.aws.amazon.com/route53/home) This will be used for setting up the domains for the UI and API. Put the desired domain name (e.g. `ef-cms.example.gov.`) and make sure it is a `Public Hosted Zone`. This is the value you will set for `EFCMS_DOMAIN` in CircleCI. Make sure the domain name ends with a period.
- [Create a SonarCloud account](https://sonarcloud.io/). SonarCloud will be used to tests each build.
- [Create a new SonarCloud organization](https://sonarcloud.io/create-organization).
@@ -202,23 +203,23 @@ Follow these steps for creating the end of sprint PRs for the court.
- [Create a project and project key](https://sonarcloud.io/projects/create?manual=true) for the SHARED code. (This will be referred to as `SHARED_SONAR_TOKEN` when setting up Jenkins.)

## Circle CI Setup
1. Setup a Circle CI account
2. Click Add Projects
1. Set up a [CircleCI](https://circleci.com/) account
2. Click "Add Projects"
3. Click "Set Up Project" next to the court's repo
4. Click "Start Building" with defaults
5. Go to the settings of the project in Circle via clicking on the project / job, and clicking the gear cog
5. Go to the settings of the project in CircleCI via clicking on the project / job, and clicking the gear icon
6. Click "Environment Variables"
7. Add the following:
- AWS_ACCESS_KEY_ID (the access key for the AWS CircleCI user created in the Prerequisites)
- AWS_SECRET_ACCESS_KEY (the secret access key for the AWS CircleCI user created in the Prerequisites)
- EFCMS_DOMAIN (the domain indented for use by the court, e.g., `ef-cms.example.gov`)
- SONAR_ORG (your sonar organization’s name)
- SHARED_SONAR_KEY (the sonar key for the SHARED project)
- SHARED_SONAR_TOKEN (the token for the sonar SHARED project)
- API_SONAR_KEY (the sonar key for the API project)
- API_SONAR_TOKEN (the token for the sonar API project)
- UI_SONAR_KEY (the sonar key for the UI project)
- UI_SONAR_TOKEN (the token for the sonar UI project)
- COGNITO_SUFFIX (a suffix of your choice for the cognito url)
- USTC_ADMIN_PASS (a unique password of your choice used by the cognito admin user)
8. You're good to go. Builds should start running and deploying if everything is setup correctly.
- `AWS_ACCESS_KEY_ID` (the access key for the AWS CircleCI user created in the Prerequisites)
- `AWS_SECRET_ACCESS_KEY` (the secret access key for the AWS CircleCI user created in the Prerequisites)
- `EFCMS_DOMAIN` (the domain indented for use by the court, e.g., `ef-cms.example.gov`)
- `SONAR_ORG` (your sonar organization’s name)
- `SHARED_SONAR_KEY` (the sonar key for the SHARED project)
- `SHARED_SONAR_TOKEN` (the token for the sonar SHARED project)
- `API_SONAR_KEY` (the sonar key for the API project)
- `API_SONAR_TOKEN` (the token for the sonar API project)
- `UI_SONAR_KEY` (the sonar key for the UI project)
- `UI_SONAR_TOKEN` (the token for the sonar UI project)
- `COGNITO_SUFFIX` (a suffix of your choice for the cognito url)
- `USTC_ADMIN_PASS` (a unique password of your choice used by the cognito admin user)
8. Run a build.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 62ae9b0

Please sign in to comment.