{"id":17685640,"url":"https://github.com/ghaiklor/generator-sails-rest-api","last_synced_at":"2025-04-05T05:02:38.030Z","repository":{"id":26466181,"uuid":"29917715","full_name":"ghaiklor/generator-sails-rest-api","owner":"ghaiklor","description":"Yeoman generator for scaffolding Sails REST API with predefined features","archived":false,"fork":false,"pushed_at":"2021-04-28T10:28:29.000Z","size":2674,"stargazers_count":335,"open_issues_count":17,"forks_count":52,"subscribers_count":19,"default_branch":"dev","last_synced_at":"2024-12-30T21:15:55.952Z","etag":null,"topics":["javascript","nodejs","rest-api","sails","scaffold","scaffolding","yeoman","yeoman-generator"],"latest_commit_sha":null,"homepage":"http://ghaiklor.github.io/generator-sails-rest-api/","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/ghaiklor.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-01-27T14:30:36.000Z","updated_at":"2024-10-04T00:02:29.000Z","dependencies_parsed_at":"2022-08-24T16:50:57.385Z","dependency_job_id":null,"html_url":"https://github.com/ghaiklor/generator-sails-rest-api","commit_stats":null,"previous_names":[],"tags_count":63,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ghaiklor%2Fgenerator-sails-rest-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ghaiklor%2Fgenerator-sails-rest-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ghaiklor%2Fgenerator-sails-rest-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ghaiklor%2Fgenerator-sails-rest-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ghaiklor","download_url":"https://codeload.github.com/ghaiklor/generator-sails-rest-api/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247289409,"owners_count":20914464,"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":["javascript","nodejs","rest-api","sails","scaffold","scaffolding","yeoman","yeoman-generator"],"created_at":"2024-10-24T10:28:32.209Z","updated_at":"2025-04-05T05:02:38.005Z","avatar_url":"https://github.com/ghaiklor.png","language":"JavaScript","readme":"# generator-sails-rest-api\n\n_This project is no longer supported. The only author and contributor who was using Sails and wrote the tool to simplify his regular work quit working with Node.js REST APIs and Sails. Though, if you are interested in take an ownership and became a full-plegded contributor, send a note to ghaiklor@gmail.com._\n\n[![Join the chat at https://gitter.im/ghaiklor/generator-sails-rest-api](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ghaiklor/generator-sails-rest-api?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n\n![Downloads](https://img.shields.io/npm/dm/generator-sails-rest-api.svg)\n![Downloads](https://img.shields.io/npm/dt/generator-sails-rest-api.svg)\n![npm version](https://img.shields.io/npm/v/generator-sails-rest-api.svg)\n![License](https://img.shields.io/npm/l/generator-sails-rest-api.svg)\n\n[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\n![dependencies](https://img.shields.io/david/ghaiklor/generator-sails-rest-api.svg)\n![dev dependencies](https://img.shields.io/david/dev/ghaiklor/generator-sails-rest-api.svg)\n\n[![Onix-Systems](https://cloud.githubusercontent.com/assets/3625244/9819276/b40b6338-58b5-11e5-8800-c42f3ebe1242.png)](http://us.onix-systems.com/)\n\nYeoman generator that provides already configured and optimized Sails REST API with bundle of predefined features.\n\n## Build Status\n\n| Version         | Build Status                                                                                  | Coverage Status                                                                                  |\n|:---------------:|:---------------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------:|\n| Edge (dev)      | ![Edge Version](https://img.shields.io/travis/ghaiklor/generator-sails-rest-api/dev.svg)      | ![Edge Version](https://img.shields.io/coveralls/ghaiklor/generator-sails-rest-api/dev.svg)      |\n| Stable (master) | ![Stable Version](https://img.shields.io/travis/ghaiklor/generator-sails-rest-api/master.svg) | ![Stable Version](https://img.shields.io/coveralls/ghaiklor/generator-sails-rest-api/master.svg) |\n\n## Features\n\n- Generator is split in more smaller parts, so that you are able to scaffold models, policies, controllers, etc... separately;\n- Disabled hooks by default: *csrf*, *grunt*, *i18n*, *pubsub*, *session*, *sockets*, *views*;\n- Flexible questions that allow to you quickly configure database connections, services that you want to use, etc...\n- Implemented authentication layer based on passport with JWT and Local strategies, Facebook, Twitter, VKontakte, GitHub, Instagram, Google Plus and other social networks;\n- Overrides defaults `blueprints` which simplify CRUD operation in REST API and adds new features like `fields` or `populate` in requests;\n- All configuration files cleaned up and optimized for REST API;\n- Some generators can scaffold predefined functionality;\n- Sub-generator that simplifies creating cron configuration;\n- Logger generator can scaffold logging configuration for `bunyan`, `winston` or use default Sails logger;\n- Overridden responses which respond with `code` (Status Code), `message` (Status Message) and `data` (Response Data) fields;\n- Bundle of ready-2-use services like `CipherService`, `PusherService` (Push Notifications), `SmsService` and so on... You can check the table with detailed list of implemented services below;\n- Bunch of Sails adapters is already declared in `connections.js` configuration file so you can easily swap between them;\n- Implemented useful express middleware like `Connection: keep-alive` and GZip compression. In a nutshell, all what optimizes HTTP performance;\n- Swagger generator can scaffold Swagger UI Explorer for you project;\n\n## Getting Started\n\n### Console\n\nInstall **yeoman** and **generator-sails-rest-api**:\n\n```bash\nnpm install -g yo generator-sails-rest-api\n```\n\nCreate project directory and initiate the generator under the project directory:\n\n```bash\nmkdir my-project\ncd my-project\nyo sails-rest-api\n```\n\nYou will be prompted to answer to questions. Answer to those questions and you will get configured Sails project.\n\nAfter scaffolding the project you can use this project as before. Just run the `app.js` file or use npm scripts.\n\n```bash\nnpm start\n```\n\n### WebStorm 11\n\nStart creating new project and choose Yeoman type:\n\n![WebStorm 11 Create New Project](https://cloud.githubusercontent.com/assets/3625244/10912184/ed36dfa6-8250-11e5-8a0a-d64ae0a3a6fc.png)\n\nIf you have installed sails-rest-api generator then just chose it and click Next.\nOtherwise, click Install generator and search for `sails`.\n\n![WebStorm 11 Search and Install generator](https://cloud.githubusercontent.com/assets/3625244/10912249/40dc99ca-8251-11e5-989d-f0be4efae9b8.png)\n\nWhen you click Next button after the generator was chosen, answer the questions that you'd been prompted.\n\n![WebStorm 11 Prompt and Answers](https://cloud.githubusercontent.com/assets/3625244/10912293/7b090b4c-8251-11e5-8ec7-2b70c3be197e.png)\n\nCongratulations, you just have setup your first Sails REST API :+1:\n\n## Bundled Sails services\n\n| Service Name                                                          | Implemented providers                            |\n|:---------------------------------------------------------------------:|:------------------------------------------------:|\n| [CipherService](https://github.com/ghaiklor/sails-service-cipher)     | JWT                                              |\n| [HashService](https://github.com/ghaiklor/sails-service-hash)         | bcrypt                                           |\n| [ImageService](https://github.com/ghaiklor/sails-service-image)       | GraphicsMagick, ImageMagick                      |\n| [LocationService](https://github.com/ghaiklor/sails-service-location) | Google, Yandex, FreeGeoIP and a lot of others    |\n| [MailerService](https://github.com/ghaiklor/sails-service-mailer)     | direct, sendmail, SMTP, SES and a lot more       |\n| [PaymentService](https://github.com/ghaiklor/sails-service-payment)   | BrainTreePayments, Stripe                        |\n| [PusherService](https://github.com/ghaiklor/sails-service-pusher)     | Apple Push Notifications, Google Cloud Messaging |\n| [SmsService](https://github.com/ghaiklor/sails-service-sms)           | Twilio                                           |\n| [SocialService](https://github.com/ghaiklor/sails-service-social)     | Facebook                                         |\n| [StorageService](https://github.com/ghaiklor/sails-service-storage)   | Amazon S3, Local                                 |\n\n## License\n\nThe MIT License (MIT)\n\nCopyright (c) 2015 Eugene Obrezkov aka ghaiklor\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fghaiklor%2Fgenerator-sails-rest-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fghaiklor%2Fgenerator-sails-rest-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fghaiklor%2Fgenerator-sails-rest-api/lists"}