{"id":24911535,"url":"https://github.com/hackoregon/endpoint-service-catalog","last_synced_at":"2025-06-13T17:32:49.267Z","repository":{"id":18233181,"uuid":"83854831","full_name":"hackoregon/endpoint-service-catalog","owner":"hackoregon","description":null,"archived":false,"fork":false,"pushed_at":"2019-10-07T01:43:13.000Z","size":90,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-03-28T03:14:56.143Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hackoregon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-03-04T01:01:18.000Z","updated_at":"2019-10-07T01:43:15.000Z","dependencies_parsed_at":"2022-09-16T14:11:02.027Z","dependency_job_id":null,"html_url":"https://github.com/hackoregon/endpoint-service-catalog","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/hackoregon/endpoint-service-catalog","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackoregon%2Fendpoint-service-catalog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackoregon%2Fendpoint-service-catalog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackoregon%2Fendpoint-service-catalog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackoregon%2Fendpoint-service-catalog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hackoregon","download_url":"https://codeload.github.com/hackoregon/endpoint-service-catalog/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackoregon%2Fendpoint-service-catalog/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259688371,"owners_count":22896395,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-02-02T04:20:45.243Z","updated_at":"2025-06-13T17:32:49.228Z","avatar_url":"https://github.com/hackoregon.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Hack Oregon End Point Service Catalog\n\n## Purpose\n\nSimple static catalog of the the Hack Oregon APIs and endpoints.\n\n## Dependencies\n\n* Docker or Docker toolkit\n* Travis-CI\n* AWS ECS Cluster deployment keys (Contact the DevOps team)\n\n## How to build (locally)\n\n### 1.  Create Your Environment file\n\n* Create `env.sh` in the project with the following contents replacing `\u003cvariables\u003e`:\n\n```bash\n#! /bin/bash\n# Setup Project Specfics - Make sure env.sh is in the .gitignore and .dockerignore\nexport DOCKER_IMAGE=\u003cthe name of your service\u003e\nexport DOCKER_REPO=\u003cYOUR REPO\u003e\nexport DOCKER_REPO_NAMESPACE=\u003cnamespace\u003e - currently \"production\"\nexport ECS_CLUSTER=\u003cTHE NAME OF YOUR ECS CLUSTER\u003e\nexport ECS_SERVICE_NAME=\u003cTHE NAME OF THE SERVICE YOU ARE DEPLOYING TO\u003e\necho \"##############################\"\necho  Your Local Project Environment\necho \"##############################\"\necho DOCKER_IMAGE: $DOCKER_IMAGE\necho DOCKER_REPO: $DOCKER_REPO\necho DOCKER_REPO_NAMESPACE: $DOCKER_REPO_NAMESPACE\necho ECS_CLUSTER: $ECS_CLUSTER\necho ECS_SERVICE_NAME: $ECS_SERVICE_NAME\n```\n\n### 2. Setup your local environment\n\n* Run `source env.sh` to setup your local environment\n\n### 3. Build the container\n\n* Run `build-proj.sh`  to build the Container\n\n### 4. Start the project\n\n* Run `start-proj.sh` to view your service's catalog page\n\n**Note** On service deployer credentials\n\n* Your service deployment user needs to belong to a group with the following policies:\n\n* Access to the configuration bucket\n\n```json\n{\n    \"Version\": \"2012-10-17\",\n    \"Statement\": [\n        {\n            \"Effect\": \"Allow\",\n            \"Action\": [\n                \"s3:GetObject\",\n                \"s3:GetObjectVersion\"\n            ],\n            \"Resource\": \"arn:aws:s3:::assign9-config/*\"\n        }\n    ]\n}\n```\n\n* Permissions to deploy to the ECS cluster\n\n```json\n\n{\n    \"Version\": \"2012-10-17\",\n    \"Statement\": [\n        {\n            \"Effect\": \"Allow\",\n            \"Action\": [\n                \"ecs:DescribeServices\",\n                \"ecs:DescribeTaskDefinition\",\n                \"ecs:DescribeTasks\",\n                \"ecs:ListTaskDefinitions\",\n                \"ecs:ListTasks\",\n                \"ecs:RegisterTaskDefinition\",\n                \"ecs:DeregisterTaskDefinition\",\n                \"ecs:UpdateService\"\n            ],\n            \"Resource\": \"*\"\n        }\n    ]\n}\n```\n\n### 5. Setup your project in Travis\n\n* Set the following environment variables\n\n```bash\n DOCKER_REPO            # Your docker repository\n DOCKER_REPO_NAMESPACE  # production\n DOCKER_IMAGE           # endpoint-service\n DOCKER_USERNAME        # Your Docker Repository user name\n DOCKER_PASSWORD        # Your Docker Repository password\n ECS_CLUSTER            # The name of your ECS cluster\n ECS_SERVICE_NAME       # The name of the ECS service your deploying to\n AWS_DEFAULT_REGION     # THE AWS region where your cluster is located\n AWS_ACCESS_KEY_ID      # The service deployer keyid for your service\n AWS_SECRET_ACCESS_KEY  # The service deployer secret key for your service\n ```\n\n## How to deploy (to AWS)\n\n1. Make a trivial commit to this repo, once Travis-CI.com project has been configured.\n2. Merge the commit in github to master.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhackoregon%2Fendpoint-service-catalog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhackoregon%2Fendpoint-service-catalog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhackoregon%2Fendpoint-service-catalog/lists"}