{"id":19273696,"url":"https://github.com/yusufshakeel/simple-restapi-nodejs","last_synced_at":"2026-05-07T03:33:33.223Z","repository":{"id":147385318,"uuid":"618739286","full_name":"yusufshakeel/simple-restapi-nodejs","owner":"yusufshakeel","description":"This is a simple REST API project using NodeJS.","archived":false,"fork":false,"pushed_at":"2023-07-05T11:47:51.000Z","size":234,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-05T14:25:11.242Z","etag":null,"topics":["api","docker","docker-image","dockerfile","javascript","nodejs","rest","rest-api"],"latest_commit_sha":null,"homepage":"https://dyclassroom.com/docker/docker-how-to-build-docker-image-and-publish-to-dockerhub","language":"JavaScript","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/yusufshakeel.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":"2023-03-25T07:50:34.000Z","updated_at":"2023-04-02T17:45:14.000Z","dependencies_parsed_at":null,"dependency_job_id":"b4f449ea-ad1b-49ce-92ca-c6d7813bf9a4","html_url":"https://github.com/yusufshakeel/simple-restapi-nodejs","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/yusufshakeel%2Fsimple-restapi-nodejs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yusufshakeel%2Fsimple-restapi-nodejs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yusufshakeel%2Fsimple-restapi-nodejs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yusufshakeel%2Fsimple-restapi-nodejs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yusufshakeel","download_url":"https://codeload.github.com/yusufshakeel/simple-restapi-nodejs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240378871,"owners_count":19792039,"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","docker","docker-image","dockerfile","javascript","nodejs","rest","rest-api"],"created_at":"2024-11-09T20:43:50.870Z","updated_at":"2026-05-07T03:33:33.190Z","avatar_url":"https://github.com/yusufshakeel.png","language":"JavaScript","funding_links":["https://www.paypal.me/yusufshakeel"],"categories":[],"sub_categories":[],"readme":"# simple-restapi-nodejs\nThis is a simple REST API project using NodeJS.\n\n## Table of Content\n* [Prerequisite](#prerequisite)\n* [Getting started](#getting-started)\n* [Localhost server](#localhost-server)\n* [API endpoints](#api-endpoints)\n* [Docker Image](#docker-image)\n* [Docker Container in localhost](#docker-container-in-localhost)\n\n## Prerequisite\n\nThis project depends on the following.\n\n* NodeJS (v14 or higher)\n* Docker (Optional. Needed only if you want to create docker image and run the project in a container.)\n\n## Getting started\n\nThis is a NodeJS project. To get started, first install all the packages by running the following command in the terminal.\n\n```shell\nnpm i\n```\n\n## Localhost server\n\nTo start the localhost server.\n\n```shell\nnpm run start\n```\n\n## API endpoints\n\nCheck out the `docs` folder. It has the Postman collection.\n\nHome\n```\nGET /\nHost: 0.0.0.0:3000\n```\n\nLiveness\n```\nGET /liveness\nHost: 0.0.0.0:3000\n```\n\nReadiness\n```\nGET /readiness\nHost: 0.0.0.0:3000\n```\n\nMetrics\n```\nGET /metrics\nHost: 0.0.0.0:3000\n```\n\n## Tests\n\nTo run the test suite.\n\n```shell\nnpm run test\n```\n\n## Docker Image\n\nDockerHub link of this project [yusufshakeel/simple-restapi-nodejs](https://hub.docker.com/r/yusufshakeel/simple-restapi-nodejs)\n\nTo pull the image on your localhost.\n\n```shell\ndocker pull yusufshakeel/simple-restapi-nodejs\n```\n\n## Docker Container in localhost\n\nTo run the docker container in localhost.\n\n```shell\ndocker run -d -p 3000:3000 yusufshakeel/simple-restapi-nodejs\n```\n\nThis will start the server on port 3000.\n\n## License\n\nIt's free :smiley:\n\n[MIT License](https://github.com/yusufshakeel/simple-restapi-nodejs/blob/main/LICENSE) Copyright (c) 2023 Yusuf Shakeel\n\n## Donate\n\nFeeling generous :smiley: [Donate via PayPal](https://www.paypal.me/yusufshakeel)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyusufshakeel%2Fsimple-restapi-nodejs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyusufshakeel%2Fsimple-restapi-nodejs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyusufshakeel%2Fsimple-restapi-nodejs/lists"}