{"id":16673144,"url":"https://github.com/ph-7/projectu-simple-clean-nodejs-api","last_synced_at":"2025-04-09T20:05:36.699Z","repository":{"id":48826370,"uuid":"514129307","full_name":"pH-7/ProjectU-simple-clean-nodeJS-API","owner":"pH-7","description":"A simple clean REST API built with NodeJS, express with a n-tier architecture (organized into layers). My Udemy course explaining how to build it is available at: https://www.udemy.com/course/build-backend-api-node-js-and-react-frontend/","archived":false,"fork":false,"pushed_at":"2024-09-27T08:14:39.000Z","size":185,"stargazers_count":10,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-09T20:05:31.028Z","etag":null,"topics":["api","express-js","javascript","js","nodejs","podman","rest","rest-api","udemy"],"latest_commit_sha":null,"homepage":"https://www.udemy.com/course/build-backend-api-node-js-and-react-frontend/","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/pH-7.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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},"funding":{"ko_fi":"phenry","github":"pH-7"}},"created_at":"2022-07-15T04:06:03.000Z","updated_at":"2024-11-06T06:16:33.000Z","dependencies_parsed_at":"2023-12-01T00:25:02.743Z","dependency_job_id":"17015cbd-7d16-4ab3-9edc-26735a8a3264","html_url":"https://github.com/pH-7/ProjectU-simple-clean-nodeJS-API","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pH-7%2FProjectU-simple-clean-nodeJS-API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pH-7%2FProjectU-simple-clean-nodeJS-API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pH-7%2FProjectU-simple-clean-nodeJS-API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pH-7%2FProjectU-simple-clean-nodeJS-API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pH-7","download_url":"https://codeload.github.com/pH-7/ProjectU-simple-clean-nodeJS-API/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248103872,"owners_count":21048245,"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","express-js","javascript","js","nodejs","podman","rest","rest-api","udemy"],"created_at":"2024-10-12T12:24:47.307Z","updated_at":"2025-04-09T20:05:36.673Z","avatar_url":"https://github.com/pH-7.png","language":"JavaScript","readme":"# ProjectU Simple clean NodeJS API\n\nA simple clean REST API built with NodeJS, express with a n-tier architecture (organized into layers). My Udemy course explaining how to build it is available at: https://www.udemy.com/course/build-backend-api-node-js-and-react-frontend/learn/lecture/33130370#overview\n\n\n## Setting Up\n\n- Make sure you have [NodeJS](https://nodejs.org/en/download) v14 or newer innstalled.\n- Run `npm ci` to install all dependencies.\n- `npm start` to start your API on port `4000`.\n  - You can change the port by editing `src/server.js` and changing `const port = 4000;` to another port number.\n- Download [Insomnia](https://insomnia.rest/download) or [Postman](https://www.postman.com/downloads/) to send easily HTTP requests to your API.\n  - In this Udemy course, I will be using Insomnia v4.2, so Insomnia would be the recommended one.\n\n\n## Running unit tests\n\n```console\nnpm test\n```\n\nOr with `npx`\n\n```console\nnpx ava\n```\n\n## Running it with Podman\n\n1. Make sure Podman is correctly installed on your machine - https://podman.io/getting-started/installation\n2. From a command line opened , run `podman machine init`, and then `podman machine start`\n3. Then, in the project folder (still from your terminal), let's build the image with `podman build -t simple-api-image .`\n4. Once it has finished and the image successfully built, you should be able to see it by typing `podman images`\n5. Finally, let's run the image container by typing `podman run -p 4000:4000 simple-api-image` - Here, we use port `4000`, and map it to the local port `4000`.\n\n\n## 3rd-party libraries\nTo make our job easier, this API uses the some great handy libraries such as...\n\n* [Pino logging library](https://github.com/pinojs/pino)\n* [Yup schema validation](https://github.com/jquense/yup)\n* [express-rate-limit](https://github.com/express-rate-limit/express-rate-limit)\n\n\n## Author\n\n[![Pierre-Henry Soria](https://avatars.githubusercontent.com/u/1325411?s=200)](https://ph7.me 'Pierre-Henry Soria website')\n\nI'm [Pierre-Henry Soria](https://ph7.me) 👋\n\nA **super passionate** Belgian **software engineer** 🤗 And a true cheese 🧀 \u0026 chocolate 🍫 lover! 😋 You can reach me at _hi {[AT]} ph7 [{D0T}] me_\n\n[![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge\u0026logo=linkedin\u0026logoColor=white)](https://www.linkedin.com/in/ph7enry/ \"Pierre-Henry Soria LinkedIn\") [![@phenrysay](https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge\u0026logo=twitter\u0026logoColor=white)](https://twitter.com/phenrysay 'Follow Me on Twitter') [![pH-7](https://img.shields.io/badge/GitHub-100000?style=for-the-badge\u0026logo=github\u0026logoColor=white)](https://github.com/pH-7 'Follow Me on GitHub')\n\n\n## Context\n\nThis is the final source code and completed project of my [Udemy Course](https://www.udemy.com/user/pierresoria/), **Learn how to build a Backend REST API with Node JS**.\n\n\n## License\n\nThis project is distributed under [MIT license](https://opensource.org/licenses/MIT). Enjoy! 🎉\n","funding_links":["https://ko-fi.com/phenry","https://github.com/sponsors/pH-7"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fph-7%2Fprojectu-simple-clean-nodejs-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fph-7%2Fprojectu-simple-clean-nodejs-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fph-7%2Fprojectu-simple-clean-nodejs-api/lists"}