{"id":18483652,"url":"https://github.com/lucasmacori/rest-api-starter-kit","last_synced_at":"2025-05-13T20:35:06.232Z","repository":{"id":105991362,"uuid":"541199758","full_name":"lucasmacori/rest-api-starter-kit","owner":"lucasmacori","description":null,"archived":false,"fork":false,"pushed_at":"2022-10-02T16:03:46.000Z","size":57,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-12-25T14:07:11.416Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/lucasmacori.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":"2022-09-25T14:32:36.000Z","updated_at":"2022-09-25T14:34:31.000Z","dependencies_parsed_at":null,"dependency_job_id":"28959089-7b03-437a-b446-f3743448e6c0","html_url":"https://github.com/lucasmacori/rest-api-starter-kit","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/lucasmacori%2Frest-api-starter-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucasmacori%2Frest-api-starter-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucasmacori%2Frest-api-starter-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucasmacori%2Frest-api-starter-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lucasmacori","download_url":"https://codeload.github.com/lucasmacori/rest-api-starter-kit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239201215,"owners_count":19599071,"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":[],"created_at":"2024-11-06T12:36:48.592Z","updated_at":"2025-02-16T21:31:04.378Z","avatar_url":"https://github.com/lucasmacori.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Node.js REST API starter kit\n\nThis repository contains the skeleton for a Node.js REST API.\nIt runs with the following packages:\n- Express: The framework to expose data through the HTTP protocol\n- pg: The PostgreSQL driver\n- Morgan: A log framework\n- Joi: An object validation framework\n- Mocha and Chai: Unit testing / assertion frameworks to properly test the API\n- Nodemon: a package that allows quick building and execution of the API when developping\n\n## Installation\n\n1. Clone the repository\n2. Rename the project and update the description in \"package.json\" file\n3. Update NPM dependencies to the lastest version by running the following command:\n```\nnpm update\n```\n4. Install all dependencies by running the following command:\n```\nnpm install\n```\n5. Configure the database's connection string in the .env file\n6. (OPTIONAL) If you count on using the exemple routes (tasks), execute the src/v1/db.init.sql script in the PostgreSQL database\n6. Run the following command to start the server in developing mode (auto restart when editing the code):\n```\nnpm run dev\n```\n7. (OPTIONAL) Test the api with Postman (you can use the \"tasks.postman_collection.json\" file)\n8. Edit the classes and happy coding !\n\n## Project architecture\n\n- The source code is located in \"src\" directory\n- The .env file allows you to configure the api (HTTP port and database settings)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flucasmacori%2Frest-api-starter-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flucasmacori%2Frest-api-starter-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flucasmacori%2Frest-api-starter-kit/lists"}