{"id":18553950,"url":"https://github.com/elyse502/api-simple","last_synced_at":"2026-04-13T19:31:21.603Z","repository":{"id":248669125,"uuid":"823969480","full_name":"elyse502/API-SIMPLE","owner":"elyse502","description":"Backend NodeJS API with a React client","archived":false,"fork":false,"pushed_at":"2024-08-20T06:18:19.000Z","size":428,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-30T06:08:44.965Z","etag":null,"topics":["api","api-client","backend","express-js","js","nodejs","react","react-bootstrap","rest","restful-api"],"latest_commit_sha":null,"homepage":"","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/elyse502.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":"2024-07-04T05:40:00.000Z","updated_at":"2024-08-20T06:18:22.000Z","dependencies_parsed_at":"2024-11-06T21:29:34.897Z","dependency_job_id":null,"html_url":"https://github.com/elyse502/API-SIMPLE","commit_stats":null,"previous_names":["elyse502/api-simple"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/elyse502/API-SIMPLE","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elyse502%2FAPI-SIMPLE","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elyse502%2FAPI-SIMPLE/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elyse502%2FAPI-SIMPLE/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elyse502%2FAPI-SIMPLE/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/elyse502","download_url":"https://codeload.github.com/elyse502/API-SIMPLE/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elyse502%2FAPI-SIMPLE/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31768635,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-13T15:25:13.801Z","status":"ssl_error","status_checked_at":"2026-04-13T15:25:09.162Z","response_time":93,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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","api-client","backend","express-js","js","nodejs","react","react-bootstrap","rest","restful-api"],"created_at":"2024-11-06T21:19:02.621Z","updated_at":"2026-04-13T19:31:21.574Z","avatar_url":"https://github.com/elyse502.png","language":"JavaScript","readme":"\u003cdiv align=\"center\"\u003e\n  \n  # 👨‍💻 Simple clean nodeJS API 🛜\n  A simple clean `REST API built` with `NodeJS`, `express` with a n-tier architecture (organized into layers).\n\u003c/div\u003e\u003cbr /\u003e\u003chr /\u003e\u003cbr /\u003e\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\n\u003cbr /\u003e\u003chr /\u003e\u003cbr /\u003e\n\n## Running unit tests 🛠️\n\n```console\nnpm test\n```\n\nOr with `npx`\n\n```console\nnpx ava\n```\n\n\u003cbr /\u003e\u003chr /\u003e\u003cbr /\u003e\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\u003cbr /\u003e\u003chr /\u003e\u003cbr /\u003e\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\u003cbr /\u003e\u003chr /\u003e\u003cbr /\u003e\n\n## Author :black_nib:\n- _[NIYIBIZI Elysée](https://linktr.ee/niyibizi_elysee)👨🏿‍💻 | [Github](https://github.com/elyse502) | [Linkedin](https://www.linkedin.com/in/niyibizi-elys%C3%A9e/) | [Twitter](https://twitter.com/Niyibizi_Elyse)._\n\n\u003c!--I'm [Elysée NIYIBIZI](https://elyseeniyibizi.me/) 👋\n\nA **super passionate** Rwandan **software engineer** 🤗 And a true cheese 🧀 \u0026 chocolate 🍫 lover! 😋 You can reach me at _hi {[AT]} elyseeniyibizi [{D0T}] me_ --\u003e\n\n[![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge\u0026logo=linkedin\u0026logoColor=white)](https://www.linkedin.com/in/niyibizi-elys%C3%A9e/) [![@phenrysay](https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge\u0026logo=twitter\u0026logoColor=white)](https://twitter.com/Niyibizi_Elyse) [![pH-7](https://img.shields.io/badge/GitHub-100000?style=for-the-badge\u0026logo=github\u0026logoColor=white)](https://github.com/elyse502)\n\n\u003cbr /\u003e\u003chr /\u003e\u003cbr /\u003e\n\n## License 📝\n\nThis project is distributed under [MIT license](https://github.com/elyse502/API-SIMPLE/blob/main/LICENSE). Enjoy! 🎉\n\n\u003cbr /\u003e\u003chr /\u003e\u003cbr /\u003e\n\n\n\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felyse502%2Fapi-simple","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felyse502%2Fapi-simple","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felyse502%2Fapi-simple/lists"}