{"id":17462314,"url":"https://github.com/shaunevening/dockerized-express-postgres","last_synced_at":"2026-02-22T02:02:52.500Z","repository":{"id":47397406,"uuid":"200510941","full_name":"ShaunEvening/dockerized-express-postgres","owner":"ShaunEvening","description":"Template repository for creating a dockerized TypeScript Express server with Postgres","archived":false,"fork":false,"pushed_at":"2023-01-11T01:41:08.000Z","size":252,"stargazers_count":0,"open_issues_count":10,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-10-24T01:32:37.837Z","etag":null,"topics":["docker-compose","express","postgres","template","typescript"],"latest_commit_sha":null,"homepage":"","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/ShaunEvening.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":"2019-08-04T15:40:51.000Z","updated_at":"2019-08-04T23:48:19.000Z","dependencies_parsed_at":"2023-02-08T21:35:21.009Z","dependency_job_id":null,"html_url":"https://github.com/ShaunEvening/dockerized-express-postgres","commit_stats":null,"previous_names":["shaunevening/dockerized-express-postgres"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ShaunEvening/dockerized-express-postgres","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShaunEvening%2Fdockerized-express-postgres","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShaunEvening%2Fdockerized-express-postgres/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShaunEvening%2Fdockerized-express-postgres/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShaunEvening%2Fdockerized-express-postgres/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ShaunEvening","download_url":"https://codeload.github.com/ShaunEvening/dockerized-express-postgres/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShaunEvening%2Fdockerized-express-postgres/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29703254,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-21T23:35:04.139Z","status":"online","status_checked_at":"2026-02-22T02:00:08.193Z","response_time":110,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["docker-compose","express","postgres","template","typescript"],"created_at":"2024-10-18T08:24:13.262Z","updated_at":"2026-02-22T02:02:52.477Z","avatar_url":"https://github.com/ShaunEvening.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Express API Starter\n\nTemplate repository for creating a Node.js + Express server with TypeScript\n\n## Getting Started\n\nFor this project, were are using docker to contain the application.\n\n```bash\n# Build the docker container for the first time\ndocker-compose up --build\n\n# Run the existed docker container\ndocker-compose up\n\n# Tear down the docker container\ndocker-compose down\n```\n\n## Environment Variables\n\nThe express server expects a few environment variables to be included via a `dev.env` file.\nCreate this file in the root of your project with the following keys:\n\n```\nSERVER_PORT=8081\nDATABASE_HOST=\"localhost\"\nDATABASE_USER=\"starter\"\nDATABASE_PASSWORD=\"starter-dev\"\nDATABASE_NAME=\"express-starter-db\"\nDATABASE_PORT=5432\n```\n\n**NOTE:** The variables above are what this starter expects out of the box.\n\n## Database\n\nThis project is setup with a Docker Postgres image and uses pg for database migrations.\nAll files for this database are inside of the `./postgres` folder.\n\n### Tables\n\nTo set up your database tables, add your sql scripts inside of the `./postgres/tables` folder. Once your files are in there, make sure to import them all in the `./posgres/deploy_tables.sql` script.\n\n### Migrations\n\nAll migrations scripts can be found inside of the `./postgres/migrations` folder.\nIn the `package.json` there is a set of scripts for creating and running database migrations:\n\n```bash\n# Create a new migration file\nyarn db:migrate-create \u003cname_of_new_migration\u003e\n\n# Run all pending 'up' migrations\nyarn db:migrate-up\n\n# Run a single 'down' migration\nyarn db:migrate-down\n\n# Run N 'up' migrations\nyarn db:migrate-up \u003cnumber_to_run\u003e\n\n# Run N 'down' migrations\nyarn db:migrate-down \u003cnumber_to_run\u003e\n```\n\n**NOTE:** these scripts must be run inside of the docker image's bash shell while it's running and can be accessed with the following command:\n\n```bash\ndocker exec -it express-starter-api bash\n```\n\n### Entering the `psql` terminal\n\nTo make use of the psql terminal run the following command while the postgres container is running:\n\n```bash\ndocker exec -it express-starter-postgres psql -U starter -d express-starter-db\n```\n\n## Available Endpoints\n\n```\nGET /v1/health - returns that the api is running\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshaunevening%2Fdockerized-express-postgres","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshaunevening%2Fdockerized-express-postgres","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshaunevening%2Fdockerized-express-postgres/lists"}