Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ghaiklor/generator-sails-rest-api
Yeoman generator for scaffolding Sails REST API with predefined features
https://github.com/ghaiklor/generator-sails-rest-api
javascript nodejs rest-api sails scaffold scaffolding yeoman yeoman-generator
Last synced: 7 days ago
JSON representation
Yeoman generator for scaffolding Sails REST API with predefined features
- Host: GitHub
- URL: https://github.com/ghaiklor/generator-sails-rest-api
- Owner: ghaiklor
- License: mit
- Created: 2015-01-27T14:30:36.000Z (about 10 years ago)
- Default Branch: dev
- Last Pushed: 2021-04-28T10:28:29.000Z (almost 4 years ago)
- Last Synced: 2024-12-30T21:15:55.952Z (about 1 month ago)
- Topics: javascript, nodejs, rest-api, sails, scaffold, scaffolding, yeoman, yeoman-generator
- Language: JavaScript
- Homepage: http://ghaiklor.github.io/generator-sails-rest-api/
- Size: 2.55 MB
- Stars: 335
- Watchers: 19
- Forks: 52
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# generator-sails-rest-api
_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 [email protected]._
[](https://gitter.im/ghaiklor/generator-sails-rest-api?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://github.com/semantic-release/semantic-release)
[](http://commitizen.github.io/cz-cli/)
[](http://us.onix-systems.com/)
Yeoman generator that provides already configured and optimized Sails REST API with bundle of predefined features.
## Build Status
| Version | Build Status | Coverage Status |
|:---------------:|:---------------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------:|
| Edge (dev) |  |  |
| Stable (master) |  |  |
## Features
- Generator is split in more smaller parts, so that you are able to scaffold models, policies, controllers, etc... separately;
- Disabled hooks by default: *csrf*, *grunt*, *i18n*, *pubsub*, *session*, *sockets*, *views*;
- Flexible questions that allow to you quickly configure database connections, services that you want to use, etc...
- Implemented authentication layer based on passport with JWT and Local strategies, Facebook, Twitter, VKontakte, GitHub, Instagram, Google Plus and other social networks;
- Overrides defaults `blueprints` which simplify CRUD operation in REST API and adds new features like `fields` or `populate` in requests;
- All configuration files cleaned up and optimized for REST API;
- Some generators can scaffold predefined functionality;
- Sub-generator that simplifies creating cron configuration;
- Logger generator can scaffold logging configuration for `bunyan`, `winston` or use default Sails logger;
- Overridden responses which respond with `code` (Status Code), `message` (Status Message) and `data` (Response Data) fields;
- 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;
- Bunch of Sails adapters is already declared in `connections.js` configuration file so you can easily swap between them;
- Implemented useful express middleware like `Connection: keep-alive` and GZip compression. In a nutshell, all what optimizes HTTP performance;
- Swagger generator can scaffold Swagger UI Explorer for you project;
## Getting Started
### Console
Install **yeoman** and **generator-sails-rest-api**:
```bash
npm install -g yo generator-sails-rest-api
```
Create project directory and initiate the generator under the project directory:
```bash
mkdir my-project
cd my-project
yo sails-rest-api
```
You will be prompted to answer to questions. Answer to those questions and you will get configured Sails project.
After scaffolding the project you can use this project as before. Just run the `app.js` file or use npm scripts.
```bash
npm start
```
### WebStorm 11
Start creating new project and choose Yeoman type:
If you have installed sails-rest-api generator then just chose it and click Next.
Otherwise, click Install generator and search for `sails`.
When you click Next button after the generator was chosen, answer the questions that you'd been prompted.
Congratulations, you just have setup your first Sails REST API :+1:
## Bundled Sails services
| Service Name | Implemented providers |
|:---------------------------------------------------------------------:|:------------------------------------------------:|
| [CipherService](https://github.com/ghaiklor/sails-service-cipher) | JWT |
| [HashService](https://github.com/ghaiklor/sails-service-hash) | bcrypt |
| [ImageService](https://github.com/ghaiklor/sails-service-image) | GraphicsMagick, ImageMagick |
| [LocationService](https://github.com/ghaiklor/sails-service-location) | Google, Yandex, FreeGeoIP and a lot of others |
| [MailerService](https://github.com/ghaiklor/sails-service-mailer) | direct, sendmail, SMTP, SES and a lot more |
| [PaymentService](https://github.com/ghaiklor/sails-service-payment) | BrainTreePayments, Stripe |
| [PusherService](https://github.com/ghaiklor/sails-service-pusher) | Apple Push Notifications, Google Cloud Messaging |
| [SmsService](https://github.com/ghaiklor/sails-service-sms) | Twilio |
| [SocialService](https://github.com/ghaiklor/sails-service-social) | Facebook |
| [StorageService](https://github.com/ghaiklor/sails-service-storage) | Amazon S3, Local |
## License
The MIT License (MIT)
Copyright (c) 2015 Eugene Obrezkov aka ghaiklor
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.