generator-sails-rest-api

generator-sails-rest-api

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

• Disabled hooks by default: csrf, grunt, i18n, pubsub, session, views;
• Flexible questions that allow to you quickly configure database connections, services that you want to use, etc...
• Automatically parses the whole project AST for used dependencies and install them;
• Overrides default blueprints which simplify CRUD operation in REST API and add new features like fields in requests;
• Implemented AuthController, PingController and UserController;
• AuthController allows to you make signin\signup via email\password;
• PingController allows to you quickly check if server is alive and can respond;
• Already declared User model with most used fields;
• Integrated Passport with Facebook, Twitter, VKontakte, GitHub, Instagram, Google Plus and other social networks, JWT and Local authorization strategies;
• Implemented policy isAuthenticated which inject user in req via JSON Web Token checking;
• Custom 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 table with detailed list of implemented services below;
• All configuration files cleaned up and optimized for REST API;
• Implemented useful express middleware like Connection: keep-alive and GZip compression. In a nutshell, all what optimize HTTP performance;
• Winston logger with logging to console and DailyRotateFile is enabled by default;
• Simple declaring of cron tasks via config/cron.js;
• Bunch of Sails adapters is already declared in connections configuration file so you can easily swap between them;

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.