LBHackney-IT / tech-radar-api

Tech Radar API

This is the API that provides the data for the Tech Radar project.

Stack

• .NET Core as a web framework.
• nUnit as a test framework.
• DynamoDB as a datastore.

How to Run

Setup

1. Install Docker.
2. Install AWS CLI.
3. Clone this repository.
4. Open it in your IDE.

Serving locally

To serve the application, run it using your IDE of choice, we use Visual Studio CE and JetBrains Rider on Mac.

Note When running locally the appropriate database connection details are still needed.

To use a local instance of DynamoDb, this will need to be installed. This is most easily done using Docker. Run the following command, specifying the local path where you want the container's shared volume to be stored.

docker run --name dynamodb-local -p 8000:8000 -v <PUT YOUR LOCAL PATH HERE>:/data/ amazon/dynamodb-local -jar DynamoDBLocal.jar -sharedDb -dbPath /data

If you would like to see what is in your local DynamoDb instance using a simple gui, then this admin tool can do that.

The application can also be served locally using docker:

1. Add you security credentials to AWS CLI.

$ aws configure

2. Log into AWS ECR.

$ aws ecr get-login --no-include-email

3. Build and serve the application. It will be available in the port 3000.

$ make build && make serve

Running the tests

To run the tests, run the following command:

$ make test

Contributing

Creating A PR

To help with making changes to code easier to understand when being reviewed, we've added a PR template. When a new PR is created on a repo that uses this API template, the PR template will automatically fill in the Open a pull request description textbox. The PR author can edit and change the PR description using the template as a guide.

Contacts

Active Maintainers

• Selwyn Preston, Lead Developer at London Borough of Hackney ([e-mail])
• Mirela Georgieva, Lead Developer at London Borough of Hackney ([e-mail])
• Matt Keyworth, Lead Developer at London Borough of Hackney ([e-mail])

Other Contacts

• Rashmi Shetty, Product Owner at London Borough of Hackney ([e-mail])