{"id":24882839,"url":"https://github.com/dobschal/node-backend-boilerplate","last_synced_at":"2026-04-12T15:45:10.588Z","repository":{"id":173422073,"uuid":"650590639","full_name":"dobschal/node-backend-boilerplate","owner":"dobschal","description":"😋 Boilerplate for a backend application featuring NodeJS, TypeScript, Express, Postgres SQL, Docker","archived":false,"fork":false,"pushed_at":"2025-03-03T13:41:09.000Z","size":213,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-03T14:33:25.688Z","etag":null,"topics":["docker","docker-compose","express","nodejs","postgresql","typescript"],"latest_commit_sha":null,"homepage":"https://dobschal.eu","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/dobschal.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-07T11:46:16.000Z","updated_at":"2025-03-03T13:41:13.000Z","dependencies_parsed_at":null,"dependency_job_id":"ff33a972-29f4-4e12-86b5-9bee7daf033d","html_url":"https://github.com/dobschal/node-backend-boilerplate","commit_stats":null,"previous_names":["dobschal/node-backend-boilerplate"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dobschal%2Fnode-backend-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dobschal%2Fnode-backend-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dobschal%2Fnode-backend-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dobschal%2Fnode-backend-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dobschal","download_url":"https://codeload.github.com/dobschal/node-backend-boilerplate/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245806459,"owners_count":20675300,"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":["docker","docker-compose","express","nodejs","postgresql","typescript"],"created_at":"2025-02-01T13:16:33.146Z","updated_at":"2026-04-12T15:45:10.555Z","avatar_url":"https://github.com/dobschal.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Node Backend Boilerplate\n\nThis repository contains boilerplate code to cook your own backend app with NodeJS, TypeScript, Postgres SQL and Docker.\n\n## 🚀 Get Started\n\nYou need to have [Docker](https://docs.docker.com/get-docker/) installed.\n\nThen use Docker Compose to run the server.\n\n```bash\ndocker compose up\n```\n\nThis will run the server on the configured port and enable auto-restart on code changes 😎!\n\n## 🏃‍♀️ Run w/o Docker\n\nIf you want to run the server without Docker, you need to have NodeJS and NPM installed.\nAdd all environment variables into a `.env` file. See the existing template file.\nHave the database running: You can do this via docker compose:\n\n```bash\ndocker compose up -d postgres-database\n```\n\nThen install all dependencies and run the server:\n\n```bash\nnpm install\nnpm run dev\n```\n\n## 🔨 Build \u0026 Run w/ Docker\n\nBuild the docker image with name `node-boilerplate` and tag `latest`:\n\n```bash\ndocker build . -t node-server:latest\n```\n\nRun a Docker container with the previous built image and expose port 3000:\n\n```bash\ndocker run -d -p 3000:3000 node-server:latest\n```\n\n## 🔍 Linting\n\nTo enable linting, you need to have NodeJS and NPM installed.\nThen install all dependencies and use the lint script as follows:\n\n```bash\nnpm install\nnpm run lint\n```\n\n## ⚙️ Environment Variables\n\nCreate a file `.env` and put all env vars there. (Copy the `.env.template` file).\nInside the `docker-compose.yml` you can specify those env vars too.\n\n## Debugging with IntelliJ\n\nAdd a new NodeJS configuration and target the `src/index.ts` file.\nAdd all environment variables from the `.env` file to the configuration.\n\n## ☝️ Hints\n\nIf a permission error for the build folder inside the docker container occurs, try to remove the image and container\nfully and build again.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdobschal%2Fnode-backend-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdobschal%2Fnode-backend-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdobschal%2Fnode-backend-boilerplate/lists"}