Repository files navigation

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 toghaiklor@gmail.com.

Yeoman generator that provides already configured and optimized Sails REST API with bundle of predefined features.

Version	Build Status	Coverage Status
Edge (dev)
Stable (master)

• 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 defaultsblueprints which simplify CRUD operation in REST API and adds new features likefields orpopulate 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 forbunyan,winston or use default Sails logger;
• Overridden responses which respond withcode (Status Code),message (Status Message) anddata (Response Data) fields;
• Bundle of ready-2-use services likeCipherService,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 inconnections.js configuration file so you can easily swap between them;
• Implemented useful express middleware likeConnection: keep-alive and GZip compression. In a nutshell, all what optimizes HTTP performance;
• Swagger generator can scaffold Swagger UI Explorer for you project;

Installyeoman andgenerator-sails-rest-api:

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

Create project directory and initiate the generator under the project directory:

mkdir my-projectcd my-projectyo 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 theapp.js file or use npm scripts.

npm start

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 forsails.

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 👍

The MIT License (MIT)

Copyright (c) 2015 Eugene Obrezkov aka ghaiklor

Permission is hereby granted, free of charge, to any person obtaining a copyof this software and associated documentation files (the "Software"), to dealin the Software without restriction, including without limitation the rightsto use, copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom the Software isfurnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in allcopies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, 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 THESOFTWARE.