{"id":16535097,"url":"https://github.com/irenaeus-xvi/restfull-api-back-end","last_synced_at":"2026-04-11T01:07:07.944Z","repository":{"id":161006800,"uuid":"634386248","full_name":"Irenaeus-XVI/RESTFULL-API-Back-End","owner":"Irenaeus-XVI","description":"Dockerizing a RESTful API for Managing Person Objects using nodejs \u0026 express js","archived":false,"fork":false,"pushed_at":"2023-05-07T04:27:37.000Z","size":674,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-14T01:41:48.928Z","etag":null,"topics":["docker","express-js","nodejs","restfull-api"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/repository/docker/irenaeusxvi/restfull-api/general","language":"JavaScript","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/Irenaeus-XVI.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-04-30T00:11:53.000Z","updated_at":"2023-05-14T03:07:01.000Z","dependencies_parsed_at":"2023-05-28T07:30:17.617Z","dependency_job_id":null,"html_url":"https://github.com/Irenaeus-XVI/RESTFULL-API-Back-End","commit_stats":null,"previous_names":["irenaeus-xvi/restfull-api-back-end"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Irenaeus-XVI%2FRESTFULL-API-Back-End","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Irenaeus-XVI%2FRESTFULL-API-Back-End/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Irenaeus-XVI%2FRESTFULL-API-Back-End/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Irenaeus-XVI%2FRESTFULL-API-Back-End/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Irenaeus-XVI","download_url":"https://codeload.github.com/Irenaeus-XVI/RESTFULL-API-Back-End/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241686807,"owners_count":20003112,"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","express-js","nodejs","restfull-api"],"created_at":"2024-10-11T18:26:24.227Z","updated_at":"2026-04-11T01:07:07.906Z","avatar_url":"https://github.com/Irenaeus-XVI.png","language":"JavaScript","readme":"# Dockerize a RESTful API for Managing Person Objects\nThis repository contains a RESTful API for managing person objects, built with Node.js and Express.js, and Dockerize for easy deployment and scalability.\n## Prerequisites\n   Before you begin, make sure you have the following installed:\n* Docker: https://docs.docker.com/get-docker/\n## Technologies Used\nThe following technologies were used to build this project:\n- Node.js\n- Express.js\n- Docker\n## How to Run the Application in a Docker Container\nTo run the application in a Docker container, follow these steps:\n1. pull the repository:\n    **docker pull irenaeusxvi/restfull-api** \n\n\n\n2. Build the Docker image:\n\n   **docker build . -t irenaeusxvi/restfull-api -f app/Dockerfile**\n\n\n2. Run the Docker container:\n\n    **docker run -p 8000:8000 irenaeusxvi/restfull-api**\n\n    **The `-p` option maps the host port `8000` to the container port `8000`.**\n    **This will start the API in a Docker container on `http://localhost:8000`.**\n\n\n\n\n\n3. Open a web browser and navigate to `http://localhost:8000/persons` to access the API.\n\n\n\n   **You should see a message indicating that the API is running.**\n\n\n\n4. For Stopping a container\n\n   **docker stop *{Container name in your  machine}* **\n\n## API Endpoints\nThe following API endpoints are available:\n- `GET /api/persons` - get all persons\n- `GET /api/persons/{:id}` - get person by ID\n- `POST /api/persons` - create a new person\n- `PUT /api/persons/{:id}` - update person by ID\n- `DELETE /api/persons/{:id}` - delete person by ID\n## For Testing(Recommended use Postman)\n   ### To retrieve a list of all persons:\n       http://localhost:8000/persons\n   ### To retrieve a single person by ID:\n       http://localhost:8000/persons/{id}\n   ### To update a person by ID:\n       http://localhost:8000/persons/{id}\n   ### To delete a person by ID:\n       http://localhost:8000/persons/{id}\n## Conclusion\nDockerize a simple RESTful API for managing person objects using Node.js and Express.js is a straightforward process. By following the steps outlined in this README.md file, you should be able to Dockerize this API and run it in a Docker container on your local machine.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Firenaeus-xvi%2Frestfull-api-back-end","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Firenaeus-xvi%2Frestfull-api-back-end","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Firenaeus-xvi%2Frestfull-api-back-end/lists"}