forked from balderdashy/sails
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f89708f
commit 8365494
Showing
1 changed file
with
29 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,12 +2,11 @@ | |
| <a href="http://sailsjs.com"><img alt="Sails.js logo" src="http://balderdashy.github.io/sails/images/logo.png" title="Sails.js"/></a> | ||
| </h1> | ||
|
|
||
| ### [Website](http://sailsjs.com/) [Getting Started](http://sailsjs.com/get-started) [Docs](http://sailsjs.com/documentation) [Blog](http://blog.sailsjs.com/) [Submit Issue](http://sailsjs.com/bugs) | ||
| ### [Website](http://sailsjs.com/) [Get Started](http://sailsjs.com/get-started) [Docs](http://sailsjs.com/documentation) [News](http://twitter.com/sailsjs) [Submit Issue](http://sailsjs.com/bugs) | ||
|
|
||
| [](http://badge.fury.io/js/sails) [](https://gitter.im/balderdashy/sails) [](https://twitter.com/sailsjs) | ||
|
|
||
|
|
||
| Sails.js is a web framework that makes it easy to build custom, enterprise-grade Node.js apps. It is designed to resemble the MVC architecture from frameworks like Ruby on Rails, but with support for the more modern, data-oriented style of web app development. It's especially good for building realtime features like chat. | ||
| Sails.js is a [web framework](http://sailsjs.com/whats-that) that makes it easy to build custom, enterprise-grade Node.js apps. It is designed to resemble the MVC architecture from frameworks like Ruby on Rails, but with support for the more modern, data-oriented style of web app & API development. It's especially good for building realtime features like chat. | ||
|
|
||
|
|
||
| ## Installation | ||
|
|
@@ -17,22 +16,22 @@ Sails.js is a web framework that makes it easy to build custom, enterprise-grade | |
| $ npm install sails -g | ||
| ``` | ||
|
|
||
| > ######Upgrading from 0.10 or 0.11? | ||
| > The v0.12 release of Sails contains a few breaking changes which affect userland. To read the v0.12 migration guide, click [here](http://sailsjs.com/version-notes/0point12-migration-guide). | ||
| > ######Upgrading from an earlier version of Sails? | ||
| > Version migration guides for all major releases since 2013 are available on the Sails website under [**Upgrading**](http://sailsjs.com/upgrading). | ||
|
|
||
| ## Your First Sails Project | ||
|
|
||
| **Create a new app:** | ||
| ```sh | ||
| # Create the app | ||
| $ sails new testProject | ||
| $ sails new my-app | ||
| ``` | ||
|
|
||
| **Lift sails:** | ||
| ```sh | ||
| # cd into the new folder | ||
| $ cd testProject | ||
| $ cd my-app | ||
|
|
||
| # fire up the server | ||
| $ sails lift | ||
|
|
@@ -42,15 +41,16 @@ $ sails lift | |
|
|
||
| [](https://www.youtube.com/watch?v=GK-tFvpIR7c) | ||
|
|
||
| _For a more up-to-date introduction to Sails, check out the [free Platzi course](https://courses.platzi.com/classes/develop-apps-sails-js/). For a thorough walkthrough, see [Sails.js in Action](https://www.manning.com/books/sails-js-in-action) and the [conceptual documentation](http://sailsjs.com/documentation) on our website._ | ||
| _For the most up-to-date introduction to Sails, [get started here](http://sailsjs.com/get-started)._ | ||
|
|
||
| ## Compatibility | ||
|
|
||
| Sails is built on [Node.js](http://nodejs.org/), [Connect](http://www.senchalabs.org/connect/), [Express](http://expressjs.com/), and [Socket.io](http://socket.io/). | ||
| Sails is built on [Node.js](http://nodejs.org/), [Express](http://expressjs.com/), and [Socket.io](http://socket.io/). | ||
|
|
||
| Sails [controllers](http://sailsjs.com/documentation/concepts/controllers) are compatible with Connect middleware, so in most cases, you can paste code into Sails from an existing Express project and everything will work-- plus you'll be able to use WebSockets to talk to your API, and vice versa. | ||
| Sails [actions](http://sailsjs.com/documentation/concepts/actions-and-controllers) are compatible with Connect middleware, so in most cases, you can paste code into Sails from an existing Express project and everything will work-- plus you'll be able to use WebSockets to talk to your API, and vice versa. | ||
|
|
||
| The ORM, [Waterline](https://github.com/balderdashy/waterline), has a well-defined adapter system for supporting all kinds of datastores. Officially supported databases include [MySQL](https://github.com/balderdashy/sails-mysql), [PostgreSQL](https://github.com/balderdashy/sails-postgresql), [MongoDB](https://github.com/balderdashy/sails-mongo), [Redis](https://github.com/balderdashy/sails-redis), local [disk](https://github.com/balderdashy/sails-disk), and local [memory](https://github.com/balderdashy/sails-memory). [Community adapters](https://github.com/balderdashy/sails-docs/blob/master/contributing/intro-to-custom-adapters.md#notable-community-adapters) exist for [CouchDB](https://github.com/search?q=sails+couch&nwo=codeswarm%2Fsails-couchdb-orm&search_target=global&ref=cmdform), [neDB](https://github.com/adityamukho/sails-nedb), [TingoDB](https://github.com/andyhu/sails-tingo), [SQLite](https://github.com/AndrewJo/sails-sqlite3/tree/0.10), [Oracle](https://github.com/search?utf8=%E2%9C%93&q=%22sails+oracle%22+OR+%22waterline+oracle%22&type=Repositories&ref=searchresults), [MSSQL](https://github.com/misterGF/sails-mssqlserver), [DB2](https://github.com/search?q=sails+db2&type=Repositories&ref=searchresults), [ElasticSearch](https://github.com/search?q=%28elasticsearch+AND+sails%29+OR+%28elasticsearch+AND+waterline%29+&type=Repositories&ref=searchresults), [Riak](https://github.com/search?q=sails+riak&type=Repositories&ref=searchresults), | ||
| The ORM, [Waterline](https://github.com/balderdashy/waterline), has a well-defined adapter system for supporting all kinds of datastores. Officially supported databases include [MySQL](https://npmjs.com/package/sails-mysql), [PostgreSQL](https://npmjs.com/package/sails-postgresql), [MongoDB](https://npmjs.com/package/sails-mongo), [Redis](https://npmjs.com/package/sails-redis), and [local disk / memory](https://npmjs.com/package/sails-disk). | ||
| Community adapters exist for [CouchDB](https://github.com/search?q=sails+couch&nwo=codeswarm%2Fsails-couchdb-orm&search_target=global&ref=cmdform), [neDB](https://github.com/adityamukho/sails-nedb), [TingoDB](https://github.com/andyhu/sails-tingo), [SQLite](https://github.com/AndrewJo/sails-sqlite3/tree/0.10), [Oracle](https://github.com/search?utf8=%E2%9C%93&q=%22sails+oracle%22+OR+%22waterline+oracle%22&type=Repositories&ref=searchresults), [MSSQL](https://github.com/misterGF/sails-mssqlserver), [DB2](https://github.com/search?q=sails+db2&type=Repositories&ref=searchresults), [ElasticSearch](https://github.com/search?q=%28elasticsearch+AND+sails%29+OR+%28elasticsearch+AND+waterline%29+&type=Repositories&ref=searchresults), [Riak](https://github.com/search?q=sails+riak&type=Repositories&ref=searchresults), | ||
| [neo4j](https://www.npmjs.org/package/sails-neo4j), [OrientDB](https://github.com/appscot/sails-orientdb), | ||
| [Amazon RDS](https://github.com/TakenPilot/sails-rds), [DynamoDB](https://github.com/TakenPilot/sails-dynamodb), [Azure Tables](https://github.com/azuqua/sails-azuretables), [RethinkDB](https://github.com/gutenye/sails-rethinkdb) and [Solr](https://github.com/sajov/sails-solr); for various 3rd-party REST APIs like Quickbooks, Yelp, and Twitter, including a configurable generic [REST API adapter](https://github.com/zohararad/sails-rest); plus some [eclectic projects](https://www.youtube.com/watch?v=OmcQZD_LIAE). | ||
|
|
||
|
|
@@ -63,28 +63,23 @@ The ORM, [Waterline](https://github.com/balderdashy/waterline), has a well-defin | |
| <a target="_blank" href="http://redis.io/"><img width="75" title="Redis" src="http://i.imgur.com/dozv0ub.jpg"/></a> | ||
| <!-- /core adapter logos --> | ||
|
|
||
| > For the latest core adapters and notable community adapters, see [Available Adapters](http://sailsjs.com/documentation/concepts/extending-sails/adapters/available-adapters). | ||
| ## Books | ||
| - [Sails.js in Action](https://www.manning.com/books/sails-js-in-action) by Mike McNeil and Irl Nathan (Manning Publications). Available December 2016 _([estimated](https://www.manning.com/meap-program#section-faq-10))_. | ||
| - [Sails.js in Action](https://www.manning.com/books/sails-js-in-action) by Mike McNeil and Irl Nathan (Manning Publications). | ||
| - [Sails.js Essentials](https://www.packtpub.com/web-development/sailsjs-essentials) by Shaikh Shahid (Packt) | ||
| - [Pro Express.js: Part 3](http://link.springer.com/chapter/10.1007%2F978-1-4842-0037-7_18) by Azat Mardan (Apress). | ||
|
|
||
| ## Support | ||
| Need help or have a question? | ||
| - [FAQ](http://sailsjs.com/faq) | ||
| - [StackOverflow](http://stackoverflow.com/questions/tagged/sails.js) | ||
| - [Develop Web Apps in Node.js and Sails.js](https://courses.platzi.com/courses/develop-apps-sails-js/) (free video course on [Platzi](http://platzi.com)) | ||
| - [Gitter Chat Room](https://gitter.im/balderdashy/sails) | ||
| - [Sails.js in Action](https://www.manning.com/books/sails-js-in-action) (our book that guides you through building a basic app) | ||
| - [Professional/Enterprise Support](http://sailsjs.com/flagship) | ||
| - [Frequently Asked Questions (FAQ)](http://sailsjs.com/faq) | ||
| - [Tutorials](http://sailsjs.com/faq#?what-are-some-good-community-tutorials) | ||
| - [Community support](http://sailsjs.com/support) | ||
| - [Professional/Enterprise options](http://sailsjs.com/faq#?are-there-professional-support-options) | ||
|
|
||
|
|
||
| ## Issue Submission | ||
| Please read the [issue submission guidelines](https://github.com/balderdashy/sails/blob/master/CONTRIBUTING.md#opening-issues) before opening a new issue. | ||
|
|
||
| Sails is composed of a [number of different sub-projects](http://sailsjs.com/architecture), many of which have their own dedicated repository. If you suspect an issue in one of these sub-modules, you can find its repo in [MODULES.md](./MODULES.md). Click [here](https://github.com/balderdashy/sails/search?q=&type=Issues) to search/post issues in this repository. | ||
|
|
||
| ## Feature Requests | ||
| If you have an idea for a new feature, please feel free to submit it as a pull request to the [_Backlog_ section of the ROADMAP.md](./ROADMAP.md#backlog) file in this repository. | ||
| Please read the [submission guidelines](http://sailsjs.com/documentation/contributing/issue-contributions) and [code of conduct](http://sailsjs.com/documentation/contributing/code-of-conduct) before opening a new issue. Click [here](https://github.com/balderdashy/sails/search?q=&type=Issues) to search/post issues in this repository. | ||
|
|
||
| ## Contribute | ||
| There are many different ways you can contribute to Sails: | ||
|
|
@@ -94,33 +89,33 @@ There are many different ways you can contribute to Sails: | |
| - writing [tests](https://github.com/balderdashy/sails/blob/master/test/README.md) | ||
| - writing a [tutorial](https://github.com/sails101/contribute-to-sails101), giving a [talk](http://lanyrd.com/search/?q=sailsjs), or supporting [your local Sails meetup](http://www.meetup.com/find/?allMeetups=false&keywords=sails.js&radius=Infinity&sort=default) | ||
| - troubleshooting [reported issues](http://sailsjs.com/bugs) | ||
| - and [submitting patches](http://sailsjs.com/contribute). | ||
| - and [submitting patches](http://sailsjs.com/documentation/contributing/code-submission-guidelines). | ||
|
|
||
| Please carefully read our [contribution guide](http://sailsjs.com/documentation/contributing) and check the [build status](./MODULES.md) for the relevant branch before submitting a pull request with code changes. | ||
| _Please carefully read our [contribution guide](http://sailsjs.com/documentation/contributing) and check the [build status](http://sailsjs.com/architecture) for the relevant branch before submitting a pull request with code changes._ | ||
|
|
||
|
|
||
| ## Links | ||
| - [Website](http://sailsjs.com/) | ||
| - [Official Documentation](http://sailsjs.com/documentation) | ||
| - [Blog](http://blog.sailsjs.com) | ||
| - [Twitter](https://twitter.com/sailsjs) | ||
| - [Roadmap](http://sailsjs.com/roadmap) | ||
| - [Google Group](https://groups.google.com/forum/#!forum/sailsjs) | ||
| - [Documentation](http://sailsjs.com/documentation) | ||
| - [Ask a question](http://sailsjs.com/support) | ||
| - [Roadmap](https://trello.com/b/s9zEnyG7/sails-v1) | ||
| - [Twitter (@sailsjs)](https://twitter.com/sailsjs) | ||
| - [Newsgroup](https://groups.google.com/forum/#!forum/sailsjs) | ||
| - [Facebook](https://www.facebook.com/sailsjs) | ||
|
|
||
| ## Team | ||
| Sails is actively maintained by [The Sails Company](http://sailsjs.com) ([@sailsjs](http://twitter.com/sailsjs)), with the help of many other amazing [contributors](https://github.com/balderdashy/sails/graphs/contributors). Our core team consists of: | ||
| Sails is actively maintained with the help of many amazing [contributors](https://github.com/balderdashy/sails/graphs/contributors). Our core team consists of: | ||
|
|
||
| [](http://twitter.com/mikermcneil) | [](http://twitter.com/particlebanana) | [](http://twitter.com/sgress454) | [](http://twitter.com/irlnathan) | [](http://twitter.com/fancydoilies) | ||
| :---:|:---:|:---:|:---:|:---: | ||
| [Mike McNeil](http://github.com/mikermcneil) | [Cody Stoltman](https://github.com/particlebanana) | [Scott Gress](https://github.com/sgress454) | [Irl Nathan](https://github.com/irlnathan) | [Rachael Shaw](https://github.com/rachaelshaw) | ||
|
|
||
| Back in 2012, we were designing/builing scalable Node.js apps for startups and enterprise customers. After building a few applications and taking them into production, we realized that the Node.js development landscape was very much still the Wild West. Over time, after trying lots of different methodologies, we decided to crystallize all of our best practices into this framework. Four years later, Sails is now one of the most widely-used web application frameworks in the world. We hope it saves you some time! :) | ||
| [The Sails Company](http://sailsjs.com/about) designs/builds scalable Node.js apps for startups and enterprise customers. After building a few applications and taking them into production, we realized that the Node.js development landscape was very much still the Wild West. Over time, after trying lots of different methodologies, we decided to crystallize all of our best practices into this framework. Five years later, Sails is now one of the most widely-used web application frameworks in the world. I hope it saves you some time! :) | ||
|
|
||
| ## License | ||
|
|
||
| [MIT License](http://sailsjs.com/license) Copyright © 2012-2017 Mike McNeil, Balderdash Design Co., & The Sails Company | ||
|
|
||
| > Sails is built around so many great open-source technologies that it would never have crossed our minds to keep it proprietary. We owe huge gratitude and props to TJ Holowaychuk ([@tj](https://github.com/tj)) and Guillermo Rauch ([@rauchg](https://github.com/rauchg)) for the work they've done, as well as the stewards of all the other open-source modules we use. Sails could never have been developed without your tremendous contributions to the node community. | ||
| > Sails is built around so many great open-source technologies that it would never have crossed our minds to keep it proprietary. We owe huge gratitude and props to Ryan Dahl ([@ry](https://github.com/ry)), TJ Holowaychuk ([@tj](https://github.com/tj)), Doug Wilson ([@dougwilson](https://github.com/dougwilson)) and Guillermo Rauch ([@rauchg](https://github.com/rauchg)) for the work they've done, as well as the stewards of all the other open-source modules we use. Sails could never have been developed without your tremendous contributions to the JavaScript community. | ||
| ![[email protected]](http://sailsjs.com/images/bkgd_squiddy.png) | ||