{"id":16680633,"url":"https://github.com/verdagio/tsc-express-api","last_synced_at":"2026-04-10T07:14:53.088Z","repository":{"id":121639188,"uuid":"169986160","full_name":"Verdagio/tsc-express-api","owner":"Verdagio","description":"Boilerplate typescript-express api which implements auth0, mongodb, ssl and is container ready","archived":false,"fork":false,"pushed_at":"2019-04-27T07:34:49.000Z","size":45,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-20T05:35:11.462Z","etag":null,"topics":["auth0","docker","express","mongodb","mongoose","restful-api","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Verdagio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2019-02-10T14:21:17.000Z","updated_at":"2019-05-04T15:25:55.000Z","dependencies_parsed_at":null,"dependency_job_id":"98e29a01-2787-4877-b1c6-fca71e0b54eb","html_url":"https://github.com/Verdagio/tsc-express-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Verdagio%2Ftsc-express-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Verdagio%2Ftsc-express-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Verdagio%2Ftsc-express-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Verdagio%2Ftsc-express-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Verdagio","download_url":"https://codeload.github.com/Verdagio/tsc-express-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243374209,"owners_count":20280656,"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":["auth0","docker","express","mongodb","mongoose","restful-api","typescript"],"created_at":"2024-10-12T13:42:12.651Z","updated_at":"2025-12-29T07:33:38.660Z","avatar_url":"https://github.com/Verdagio.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tsc-express-api\nBoilerplate TypeScript-Express API that implements auth0 and containerization\n\n## Before you use!\n\n```npm install```\n\nConfig is used to grab values from a json file for auth0 and environment values.\n\n 1. Create config/ directory\n 2. Create config/defaults.json\n 3. Insert the following:\n\n ```\n{\n    \"Server\": {\n        \"development\": {\n            \"httpsPort\": 5443,\n            \"port\": 5000,\n            \"name\": \"Dev-Express\"\n        },\n        \"production\": {\n            \"httpsPort\": 9443,\n            \"port\": 9000,\n            \"name\": \"Express\"\n        },\n        \"test\": {\n            \"port\": 4000,\n            \"name\": \"Test-Express\"\n        },\n        \"default\": {\n            \"httpsPort\": 5443,\n            \"port\": 5000,\n            \"name\": \"Dev-Express\"\n        }\n    },\n    \"Secret\": {\n        \"audience\": \"http://your-audience/\",\n        \"domain\": \"https://yourDomain.auth0.com/\",\n        \"algorithms\": [\n            \"RS256\"\n        ]\n    },\n    \"Mongo\": {\n        \"host\": \"mongodb://mongo\",\n        \"dbname\": \"sampledb\",\n        \"user\": \"admin\",\n        \"pass\": \"password\"\n    }\n}\n ```\n If using SSL don't forget to add the port bindings to your docker-compose and .pem files to config/ dir!\n\nUse OpenSSL to generate your .pem files:\n\nOpenSSL\u003e req -newkey rsa:2048 -nodes -keyout key.pem -x509 -days 365 -out cert.pem\n\n\n If you do not already have auth0 configured follow these [instructions](https://auth0.com/docs/quickstart/backend/nodejs)\n\n## How to run (Tests to be added)\nIn your command line use any of the following:\n\nNew development build : ```docker-compose -f docker-compose.debug.yml up --build```\n\nRebuild devevelopment : ```docker-compose -f docker-compose.debug.yml up --build --no-deps```\n\nRun test suite : ```docker-compose -f docker-compose.test.yml up --no-deps```\n\nProduction ready build : ```docker-compose up --build```\n\n#### Run out of container \n\n(note Error may occur for mongodb connection if not setup on local machine)\n\nBuild: ```npm run build```\n\nStart: ```npm start```\n\nTest: ```npm run test```\n\nDevelopment run : ```npm run dev```\n\nProduction run : ```npm run prod```\n\n## Swagger UI Docs\n\nOnce your service is up and running go to the following:\n\n```http://localhost:9000/api-docs```\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fverdagio%2Ftsc-express-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fverdagio%2Ftsc-express-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fverdagio%2Ftsc-express-api/lists"}