{"id":15481247,"url":"https://github.com/dalenguyen/rest-api-node-typescript","last_synced_at":"2025-04-05T02:10:53.011Z","repository":{"id":45187196,"uuid":"129656941","full_name":"dalenguyen/rest-api-node-typescript","owner":"dalenguyen","description":"Building RESTful Web APIs with Node.js, Express, MongoDB and TypeScript","archived":false,"fork":false,"pushed_at":"2023-02-01T16:00:03.000Z","size":775,"stargazers_count":472,"open_issues_count":4,"forks_count":160,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-03-29T01:13:05.433Z","etag":null,"topics":["express","hacktoberfest","mongodb","nodejs","typescript"],"latest_commit_sha":null,"homepage":"https://restful-api-node-typescript.books.dalenguyen.me","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/dalenguyen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"docs/security-for-our-web-apis.rst","support":null},"funding":{"github":"dalenguyen","patreon":null,"open_collective":null,"ko_fi":"dalenguyen","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2018-04-15T22:37:39.000Z","updated_at":"2025-03-23T23:02:47.000Z","dependencies_parsed_at":"2023-02-17T07:30:47.620Z","dependency_job_id":null,"html_url":"https://github.com/dalenguyen/rest-api-node-typescript","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dalenguyen%2Frest-api-node-typescript","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dalenguyen%2Frest-api-node-typescript/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dalenguyen%2Frest-api-node-typescript/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dalenguyen%2Frest-api-node-typescript/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dalenguyen","download_url":"https://codeload.github.com/dalenguyen/rest-api-node-typescript/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247276189,"owners_count":20912288,"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":["express","hacktoberfest","mongodb","nodejs","typescript"],"created_at":"2024-10-02T05:02:53.911Z","updated_at":"2025-04-05T02:10:52.993Z","avatar_url":"https://github.com/dalenguyen.png","language":"TypeScript","funding_links":["https://github.com/sponsors/dalenguyen","https://ko-fi.com/dalenguyen"],"categories":[],"sub_categories":[],"readme":"# Building RESTful Web APIs with Node.js, Express, MongoDB and TypeScript\n\nThis is a simple API that saves contact information of people. \n\nThere are two versions of this project. \n\n- [V1.0.0](https://github.com/dalenguyen/rest-api-node-typescript/tree/v1.0.0): you can run the server directly after cloning this version. It will create a simple RESTful API over HTTP. \n- [V2.0.0](https://github.com/dalenguyen/rest-api-node-typescript/tree/v2.0.0): this is a more secure and control API project. You need to read the post on [how to secure RESTful API application](https://itnext.io/building-restful-web-apis-with-node-js-express-mongodb-and-typescript-part-5-a80e5a7f03db) first. After that, you can run the project.\n\n## Requirements\n\n[NodeJS](https://nodejs.org/en/)\n\nInstall global TypeScript and TypeScript Node\n\n```\nnpm install -g typescript ts-node\n```\n\n## Getting Started\n\nYou should install [MongoDB](https://docs.mongodb.com/manual/administration/install-community/) on your local machine, or use other services such as [mLab](https://mlab.com/) or [Compose](https://www.compose.com/compare/mongodb)\n\nAfter that, you will have to replace the mongoURL with your MongoDB address in *lib/app.ts*\n\n## Clone this repository\n\n```\ngit clone git@github.com:dalenguyen/rest-api-node-typescript.git .\n```\n\nThen install the dependencies\n\n```\nnpm install\n```\n\n## Start the server\n\nRun in development mode\n\n```\nnpm run dev\n```\n\nRun in production mode \n\n```\nnpm run prod\n```\n\n## Testing over HTTP (tag [v1.0.0](https://github.com/dalenguyen/rest-api-node-typescript/tree/v1.0.0))\n\nThe default URL is: *http://localhost:3000*\n\n+ GET all contacts\n\n```\nSend GET request to http://localhost:3000/contact/\n```\n\n## Testing over HTTPs (tag [v2.0.0](https://github.com/dalenguyen/rest-api-node-typescript/tree/v2.0.0))\n\nThe default URL is: *https://localhost:3000*\n\nThe key and cert in the config folder is for testing purpose only. You should generate your own.\n\n*Reference from [Lynda.com](https://www.lynda.com/Node-js-tutorials/Next-steps/633869/671263-4.html)*","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdalenguyen%2Frest-api-node-typescript","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdalenguyen%2Frest-api-node-typescript","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdalenguyen%2Frest-api-node-typescript/lists"}