{"id":14989715,"url":"https://github.com/cham11ng/typescript-api-starter","last_synced_at":"2025-04-06T00:09:46.554Z","repository":{"id":41186761,"uuid":"119154946","full_name":"cham11ng/typescript-api-starter","owner":"cham11ng","description":"Node.js (🤖) Express.js / PostgreSQL API in TypeScript","archived":false,"fork":false,"pushed_at":"2025-01-26T03:32:07.000Z","size":3115,"stargazers_count":100,"open_issues_count":0,"forks_count":17,"subscribers_count":3,"default_branch":"dev","last_synced_at":"2025-03-29T23:09:56.082Z","etag":null,"topics":["api","backpack","chai","docker","docker-compose","eslint","express","github-actions","hacktoberfest","jest","knex","knexjs","migration","nodejs","objection","objectionjs","prettier","seed","typescript","winston"],"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/cham11ng.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":"2018-01-27T10:36:45.000Z","updated_at":"2025-01-26T03:32:10.000Z","dependencies_parsed_at":"2023-02-18T17:00:54.533Z","dependency_job_id":"49356e22-b50a-4e85-b1ed-f50b799a965d","html_url":"https://github.com/cham11ng/typescript-api-starter","commit_stats":{"total_commits":255,"total_committers":4,"mean_commits":63.75,"dds":0.4509803921568627,"last_synced_commit":"dd2c86bcff30698ab5374349e5f0c29300344332"},"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cham11ng%2Ftypescript-api-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cham11ng%2Ftypescript-api-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cham11ng%2Ftypescript-api-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cham11ng%2Ftypescript-api-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cham11ng","download_url":"https://codeload.github.com/cham11ng/typescript-api-starter/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247415967,"owners_count":20935387,"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":["api","backpack","chai","docker","docker-compose","eslint","express","github-actions","hacktoberfest","jest","knex","knexjs","migration","nodejs","objection","objectionjs","prettier","seed","typescript","winston"],"created_at":"2024-09-24T14:18:48.867Z","updated_at":"2025-04-06T00:09:46.532Z","avatar_url":"https://github.com/cham11ng.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\u003ca href=\"https://imgur.com/A1URjPL\"\u003e\u003cimg alt=\"Typescript API Starter\" src=\"https://i.imgur.com/A1URjPL.png\"\u003e\u003c/a\u003e\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/cham11ng/typescript-api-starter/actions/workflows/ci.yml\"\u003e\n    \u003cimg src=\"https://github.com/cham11ng/typescript-api-starter/actions/workflows/ci.yml/badge.svg\" alt=\"Build Status\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\nThis is a API starter template for building a Node.js and Express.js using Typescript and PostgreSQL as database. It includes popular tools such as jsonwebtoken, joi, Knex, Objection.js, and more.\n\n## Requirements\n\n- [Node.js](https://yarnpkg.com/en/docs/install)\n- [Yarn](https://yarnpkg.com/en/docs/install)\n- [NPM](https://docs.npmjs.com/getting-started/installing-node)\n- [Docker](https://docs.docker.com/install/)\n\n## Getting Started\n\n```bash\n# Clone repository\n$ git clone git@github.com:cham11ng/typescript-api-starter.git \u003capplication-name\u003e\n\n$ cd \u003capplication-name\u003e\n\n# Update database credentials\n$ cp .env.example .env\n\n# Install dependencies\n$ yarn install\n\n$ yarn migrate\n```\n\n```bash\n# Load fake data in database.\n$ yarn load:fake \u003cFactoryName\u003e \u003cNumber\u003e\n```\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://imgur.com/gallery/d2M09Qj\"\u003e\u003cimg src=\"https://i.imgur.com/d2M09Qj.gif\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nStart the application.\n\n```bash\n# For production\n$ yarn build\n\n# For development\n$ yarn dev\n```\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://imgur.com/gallery/4rhTo\"\u003e\u003cimg src=\"https://i.imgur.com/GpcDbLB.gif\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n### Using Docker\n\n```bash\n$ docker compose up -d api\n\n# Make sure server is started checking logs before running this command\n$ docker compose exec api sh yarn migrate\n```\n\n```bash\n# View logs of the container.\n$ docker compose logs -f api\n\n# To stop the services.\n$ docker compose stop api postgres\n```\n\n## Generating Migrations and Seeds\n\n```bash\n# To create migration use `make:migration`\n$ yarn make:migration create_{table_name}_table\n\n# To create seed use `make:seeder`\n$ yarn make:seeder {table_name}_table_seeder\n```\n\n```bash\n# Example\n$ yarn make:migration create_posts_table\n$ yarn make:seeder post_table_seeder\n```\n\nModify migration and seeder file as per the requirement. Then finally:\n\n```bash\n# to migrate\n$ yarn migrate\n\n# to seed\n$ yarn seed\n```\n\n## Setting up REST Client\n\nCreate a file or add following lines in `.vscode` \u003e `settings.json` and switch an environment `Cmd/Ctrl + Shift + P` \u003e `REST Client: Switch Environment`. Then, you can request APIs from `api.rest` file.\n\n```json\n{\n  \"rest-client.environmentVariables\": {\n    \"$shared\": {\n      \"refreshToken\": \"foo\",\n      \"accessToken\": \"bar\",\n      \"email\": \"sgr.raee@gmail.com\",\n      \"password\": \"secret\"\n    },\n    \"local\": {\n      \"host\": \"localhost\",\n      \"refreshToken\": \"{{$shared refreshToken}}\",\n      \"accessToken\": \"{{$shared accessToken}}\",\n      \"email\": \"{{$shared email}}\",\n      \"password\": \"{{$shared password}}\"\n    }\n  }\n}\n```\n\n## Contributing\n\nFeel free to send pull requests.\n\n## License\n\ntypescript-api-starter is under [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcham11ng%2Ftypescript-api-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcham11ng%2Ftypescript-api-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcham11ng%2Ftypescript-api-starter/lists"}