{"id":16736330,"url":"https://github.com/nutboltu/express-restful-starter","last_synced_at":"2025-04-10T12:21:52.087Z","repository":{"id":57231902,"uuid":"83114290","full_name":"nutboltu/express-restful-starter","owner":"nutboltu","description":"This is a starter kit for building RESTful APIs with ES6, Express framework and Passportjs","archived":false,"fork":false,"pushed_at":"2020-08-20T14:57:57.000Z","size":20,"stargazers_count":10,"open_issues_count":2,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-24T11:08:28.069Z","etag":null,"topics":["es6","express","passport","rest-api","starter-kit"],"latest_commit_sha":null,"homepage":"","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/nutboltu.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}},"created_at":"2017-02-25T07:19:45.000Z","updated_at":"2020-01-24T19:35:22.000Z","dependencies_parsed_at":"2022-09-04T20:03:44.707Z","dependency_job_id":null,"html_url":"https://github.com/nutboltu/express-restful-starter","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nutboltu%2Fexpress-restful-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nutboltu%2Fexpress-restful-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nutboltu%2Fexpress-restful-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nutboltu%2Fexpress-restful-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nutboltu","download_url":"https://codeload.github.com/nutboltu/express-restful-starter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248102158,"owners_count":21048116,"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":["es6","express","passport","rest-api","starter-kit"],"created_at":"2024-10-13T00:09:04.023Z","updated_at":"2025-04-10T12:21:52.069Z","avatar_url":"https://github.com/nutboltu.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Express RESTful Starter\n\nThis is a starter kit for building RESTful APIs with ES6, Express framework and Passport\n\n## Getting started\n\n---------------\n\n```sh\n# Clone the repository\ngit clone git@github.com:nutboltu/express-restful-starter.git\ncd express-restful-starter\n\n# Remove this git config\nrm -rf .git\n\n# Install dependencies\nnpm i\n\n# Start server in development environment\nnpm start\n\n# Start server in production environment\nnpm start:prod\n```\n\nThe api service runs on port 3000. We implemented following apis in this starter kit\n\n```\nBASE_PATH: http://localhost:3000/api/\n\nAuthentication\n    POST    /login\n            Request:\n                body:{\n                    username: // for mock-data farhad.yasir\n                    password: // for mock-data 123456\n                }\n            Response:\n            {\n                user: // a demo user info\n            }\nUsers **You must be loggedIn before calling these apis**\n    POST    /users\n            Request:\n                body:{\n                    firstName: user's first name,\n                    lastName: user's last name,\n                    email: user's email,\n                    password: user's password,\n                }\n            Response:\n            {\n                // returns same body for now. You need to update code in\n                // /models/handlers/user.model.handlers.js\n                firstName: user's first name,\n                lastName: user's last name,\n                email: user's email,\n                password: user's password,\n            }\n    PUT     /users/:id\n            Response:\n            {\n                // returns same body for now. You need to update code in\n                // /models/handlers/user.model.handlers.js\n                firstName: user's first name,\n                lastName: user's last name,\n                email: user's email,\n                password: user's password,\n            }\n    GET     /users/:offset/:limit\n            Response:\n            {\n                // returns offset and limit for now. You need to update code in\n                // /models/handlers/user.model.handlers.js\n                offset: url's offset,\n                limit: url's limit,\n            }\n    GET     /users/:id\n            Response:\n            {\n                // returns id for now. You need to update code in\n                // /models/handlers/user.model.handlers.js\n               id\n            }\n    DELETE  /users/:id\n            Response:\n            {\n                // returns id for now. You need to update code in\n                // /models/handlers/user.model.handlers.js\n               id\n            }\n```\n\n## Starter Kit Layout\n\n---------------\n\n```\n+- config\n|   +- env                    --\u003e environment dependable configuration files\n|     +- common.js            --\u003e common configurations for all environment\n|     +- development.js       --\u003e configurations for development\n|     +- production.js        --\u003e configurations for production\n|   +- index.js               --\u003e configuration file where all configurations are concatenated\n+- controllers                --\u003e controller files\n+- routes                     --\u003e REST api routers\n+- models                     --\u003e models directories that communicate with the database\n|   +- {Entity Name}          --\u003e database access layer that connects with the db models\n+- node_modules               --\u003e development dependencies node modules\n+- utilities                  --\u003e utilities files\n|   +- authentication         --\u003e uses passport as authentication\n|   +- constants              --\u003e consists application constants\n|   +- handlers               --\u003e any kinds of handlers (e.g: errorHandler, responseHandler)\n|   +- validators             --\u003e customize express validators\n+- server.js                  --\u003e application run file\n+- package.json               --\u003e node package\n```\n\n## Licence\n\nMIT licence\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnutboltu%2Fexpress-restful-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnutboltu%2Fexpress-restful-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnutboltu%2Fexpress-restful-starter/lists"}