Vimia/Sails-Core

The project consists on a Solid and Realiable Sails ⛵ Core to start developing complete apps.

######:construction: Warning: DO NOT use in production. The project still under development, we hope to release a stable version soon.

🚀 Showtime

We belive that you already installed git, node.js, npm and your favorite database.

1️⃣ Installing Sails*

$ sudo npm install sails -g

2️⃣ Cloning the project

Lets clone it from this repo:

$ git clone https://github.com/vimia/sails-core.git

Get in the project folder:

$ cd sails-core

3️⃣ Adapting the project to deploy

In the project folder create a file config/local.js:

$ touch config/local.js

and put this content:

module.exports = {
  port: 5000,
  environment: 'development',
  globals:{
    baseUrl: 'http://localhost:5000',
    baseHost: 'localhost:5000',
  },
  connections: {
    development: {
      adapter: 'sails-disk'
    }
  },
  passport: {
    github: {
        clientID: 'GH_CLIENT_ID' ,
        clientSecret: 'GH_CLIENT_SECRET',
        callbackURL:  "http://localhost:5000/auth/github/callback"
    },
  },
  //NewRelic
  config: {
  	license_key: 'YOUR_NEWRELIC_LICENSE_KEY'
  }
};

The development adapter already is sails-disk, if you'll test only with dev, there's no need for change.

4️⃣ Launching

$ sails lift

If everything woks fine, you'll be able to see it running at: http://localhost:5000

🤘 Road Map

• Look at our issues :3

Get another data input that could be here ? Open an issue

☕ From Developers for Developers

Sails Core will be coded to easily integrate several platforms.

📊 Stats

Want to help ?

So you're a kickass developer? Help us and keep open-source alive! See our issues and feel free to open a pull-request.

👏 We Use / Thanks to

Front-end

• bower - Front-end solution for packages;
• jQuery - Powerful JavaScript framework;
• moment - An easy way to handle time issues;

Back-end

• NodeJS - JavaScript runtime for easily building fast, scalable network applications;
  • SailsJS - Realtime MVC framework for node;
    • SailsCore - Simple Core with Sails JS;
  • Passport.js - An OAuth adapter;
  • bcrypt - Package to create hashs;
  • cron - Package to create scheduled tasks;
  • parse-duration - Parse duration of time string;
  • ejs-locals - Filters and Front-end parsing;
  • html-minifier - HTML Minification;
• MongoDB - An open-source NoSQL database;

Tools

• GitHub - Social coding ;
• waffle.io - Project management solution from your existing GitHub Issues;
• NewRelic - Server-side app monitor;
• Heroku - Server hosting;
• CodeShip - A really cool Continuous Integration tool, and our "Automated Deploy Manager";
• Travis - Another cool continuous integration;
• CloudFlare - Our favorite DNS Manager;

Who uses ?

• blew.io - Developers tool to share code.

Contributors

• @marceloboeira - Software Engineer & Creator