generator-sails-rest-api

Sponsorship by Onix-Systems

Join the chat at https://gitter.im/ghaiklor/generator-sails-rest-api

Downloads npm version dependencies dev dependencies License

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) Edge Version Edge Version
Stable (master) Stable Version Stable Version

Features

Getting Started

Start using generator is very simple.

First of all, you need install yeoman and generator-sails-rest-api:

npm install -g yo generator-sails-rest-api

Then create project directory and initiate the generator under the project directory:

mkdir my-project
cd my-project
yo sails-rest-api

You will be prompted for questions. Answer to those questions that generator is asks 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.

npm start

Congratulations, you just have setup your first Sails REST API :+1:

Bundled Sails services

Service Name Implemented providers
CipherService JWT
HashService bcrypt
ImageService GraphicsMagick, ImageMagick
LocationService Google, Yandex, FreeGeoIP and a lot of others
MailerService direct, sendmail, SMTP, SES and a lot more
PaymentService BrainTreePayments, Stripe
PusherService Apple Push Notifications, Google Cloud Messaging
SmsService Twilio
SocialService Facebook
StorageService 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.