Skip to content

Commit c4577bc

Browse files
author
Sam Ainsworth
authored
Merge pull request #115 from ministryofjustice/UML-3236_README
UML-3236 Update README.MD to remove CircleCI refs
2 parents a384ee1 + 763fe8a commit c4577bc

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

README.md

+15-11
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
# opg-data-lpa
22

3-
[![CircleCI](https://circleci.com/gh/ministryofjustice/opg-data-lpa/tree/main.svg?style=svg)](https://circleci.com/gh/ministryofjustice/opg-data-lpa/tree/main)
3+
OPG Use My LPA: Managed by opg-org-infra & Terraform
4+
5+
![path to live status](https://github.com/ministryofjustice/opg-data-lpa/actions/workflows/deploy.yml/badge.svg)
6+
![licence-mit](https://img.shields.io/github/license/ministryofjustice/opg-data-lpa.svg)
7+
8+
9+
[![repo standards badge](https://img.shields.io/badge/dynamic/json?color=blue&style=for-the-badge&logo=github&label=MoJ%20Compliant&query=%24.result&url=https%3A%2F%2Foperations-engineering-reports.cloud-platform.service.justice.gov.uk%2Fapi%2Fv1%2Fcompliant_public_repositories%2Fendpoint%2Fopg-data-lpa)](https://operations-engineering-reports.cloud-platform.service.justice.gov.uk/public-report/opg-data-lpa 'Link to report')
410

511
## Purpose
612

@@ -20,11 +26,11 @@ LPA related functions.
2026

2127
- Terraform (for infrastructure)
2228
- Python (for lambda code)
23-
- OpenApi spec (for building the REST API against API Gateway)
29+
- OpenAPI spec (for building the REST API against API Gateway)
2430

2531
## Running the API locally
2632

27-
- Run full setup script from the make file:
33+
- Run full setup script from the Makefile:
2834

2935
```
3036
make setup
@@ -50,11 +56,9 @@ That should be all you need to set it up locally.
5056

5157
When working on a ticket you should name your branch as the jira identifier of the ticket you are working on.
5258

53-
When you push your changes to your branch and create a PR then the CircleCi workflow will run and create a branch
54-
based environment in aws. This includes an api gateway instance, the lambda function and all the relevant DNS to access
55-
the environment.
59+
When you push your changes to your branch and create a PR then Github Actions workflow will run and create a branch-based environment in AWS. This includes an API Gateway instance, the Lambda function and all the relevant DNS to access the environment.
5660

57-
You can test against the endpoints by assuming a sirius dev role and hitting the following endpoint (replacing branch_name and api_path:
61+
You can test against the endpoints by assuming a Sirius dev role and hitting the following endpoint (replacing branch_name and api_path):
5862

5963
```
6064
https://branch_name.dev.lpa.api.opg.service.justice.gov.uk/v1/api_path
@@ -64,13 +68,13 @@ Once merged you can do the same tests against dev by removing the branch_name po
6468

6569
Environments get destroyed overnight and by default your environment is protected for the first night's destroy but
6670
will be cleaned up on the subsequent night. If you want to work on it longer either recreate it by rerunning the workflow
67-
or change the protection TTL in dynamodb.
71+
or change the protection TTL in DynamoDB.
6872

6973
## Manual setup
7074

7175
### Set up local development environment outside of docker
7276

73-
If you wish to develop against this environment and don't want to be dealing with docker containers then there
77+
If you wish to develop against this environment and don't want to be dealing with Docker containers then there
7478
is a bit more of an in depth set up process required.
7579

7680
1. Create a virtual environment
@@ -98,7 +102,7 @@ is a bit more of an in depth set up process required.
98102
pip3 install -r lambda_functions/v1/requirements/dev-requirements.txt
99103
```
100104

101-
### Running flask app locally
105+
### Running Flask app locally
102106

103107
1. `cd lambda_functions/v1/functions/lpa/app`
104108
2. `FLASK_APP=lpa SIRIUS_BASE_URL=http://localhost:5001 flask run &`
@@ -186,7 +190,7 @@ The best package to get started can be found here:
186190
You can download the latest version to a directory, unzip it and run the individual tools
187191
in the `/pact/bin` folder from the command line or put them in your PATH.
188192
First you should put the contract in our local broker. The local broker is spun up as part
189-
of the `docker-compose up -d` command and you can push in a contract manually from a json file
193+
of the `docker compose up -d` command and you can push in a contract manually from a json file
190194
by using the below command (example json included in this repo):
191195
192196
```shell

0 commit comments

Comments
 (0)