{"id":23379095,"url":"https://github.com/colevoss/ae-tests","last_synced_at":"2025-07-21T00:35:11.071Z","repository":{"id":55116183,"uuid":"326062846","full_name":"colevoss/ae-tests","owner":"colevoss","description":null,"archived":false,"fork":false,"pushed_at":"2021-01-10T21:06:34.000Z","size":284,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-08T05:51:15.588Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/colevoss.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":"2021-01-01T21:59:36.000Z","updated_at":"2021-01-09T00:46:49.000Z","dependencies_parsed_at":"2022-08-14T12:30:49.717Z","dependency_job_id":null,"html_url":"https://github.com/colevoss/ae-tests","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/colevoss/ae-tests","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/colevoss%2Fae-tests","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/colevoss%2Fae-tests/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/colevoss%2Fae-tests/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/colevoss%2Fae-tests/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/colevoss","download_url":"https://codeload.github.com/colevoss/ae-tests/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/colevoss%2Fae-tests/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266221473,"owners_count":23894966,"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":"2024-12-21T19:16:35.533Z","updated_at":"2025-07-21T00:35:11.049Z","avatar_url":"https://github.com/colevoss.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SERVICE\n\n## Getting Started\n\nTo run this project locally along with its external dependencies (Databases, Event Brokers), you will\nneed to have Docker installed. You can do that by downloading and installing it from the [Docker website](https://www.docker.com/products/docker-desktop).\n\n## Starting Service\n\nUsing Docker Compose, the service can be started in a couple different ways.\n\n### Up\n\n```bash\nnpm run up\n```\n\nUsing `npm run up` will use [docker-compose](https://docs.docker.com/compose/) to start all services.\nSee the documentation for [`docker-compose up`](https://docs.docker.com/compose/reference/up/) for more details.\n\nIn short, this command will start all services and expose the app service at [localhost:8080](http://localhost:8080).\n\n#### Background Mode\n\n```bash\nnpm run up:background\n```\n\nThis command will start the service and dependencies like `npm run up` but will exit after the containers\nare started and running allowing you to continue to use that terminal session. This uses `docker-compose`'s\n`--detach` flag. If you need to see the logs for the service or other running containers, run the following\nfrom the this repo's directory.\n\n```bash\nnpm run logs\n```\n\n#### Force Build\n\n```bash\nnpm run up:build\n```\n\nThis command will force Docker Compose to rebuild all containers before starting them. This might be\nuseful if you have made changes since the last time you up'd the service and the changes aren't being\npicked up. The `--build` flag isn't used in the `npm run up` command to make that command quicker for\nthe average use.\n\n### Down\n\nTo stop (or force stop) all running containers in this project, run `npm run down`. If you aren't running\nthe service in background mode, using `Ctrl + C` in the running terminal session will attempt to stop\nall running containers.\n\n## Development\n\nWhen running the application with `npm run up` (or its variants), making changes and saving the source\ncode will live reload the server in the container, allowing you to really speed along in your cool feature\ndevelopment or bug squashing. Go get 'em, Speed Racer!\n\n### Debugging\n\nWhen running the service in any mode (background or foreground), you can attach a debugger on port `9229`\nand use some nice debugging features.\n\nThis repo contains a [VSCode Debugging Command](/.vscode/launch.json) that, when used, will allow you\nto do things like set break points, step through the code, and inspect local variables.\n\nTo use this functionality, press `F5` while in VSCode or navigate to the `Run` menu in the sidebar and\nclick the Play button at the top next to `Attach App`\n\n## Deployment\n\nThis Project is hosted in Google App Engine. Ideally you cannot deploy any code to App Engine from a\nlocal machine, and will need to rely on our CI/CD pipelines set up in Github Actions.\n\n### Pull Requests\n\nWhen a pull request is merged to the `main` branch, a Github Action is started and will build the app,\nrun tests* and deploy that version of the application to the Staging environment in App Engine\n\n### Manual Staging Deploy\n\nYou can manually deploy a branch to staging by using the `Run Workflow` button for the [Deploy To Staging](https://github.com/colevoss/ae-tests/actions?query=workflow%3A%22Deploy+To+Staging%22) workflow and choosing the branch to deploy.\n\n### Manual Production Deploy\n\nAt this time, all deployments to production are done manually through our Github Actions. Much like the\nDeploy To Staging workflow, using the [Deploy To Production](https://github.com/colevoss/ae-tests/actions?query=workflow%3A%22Deploy+To+Production%22) workflow will deploy to Production. Although the `Run Workflow` prompt gives you the\noption to select a branch to deploy, selecting any branch other than `main` will fail the workflow and\nnot allow you to deploy. \n\n## References\n\n* [Docker](https://docs.docker.com/)\n* [Docker Desktop](https://www.docker.com/products/docker-desktop)\n* [Docker Compose](https://docs.docker.com/compose/)\n* [VSCode Debugger](https://code.visualstudio.com/docs/editor/debugging)\n* [Google App Engine](https://cloud.google.com/appengine/docs/standard/nodejs)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcolevoss%2Fae-tests","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcolevoss%2Fae-tests","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcolevoss%2Fae-tests/lists"}