Skip to content
This repository has been archived by the owner on Apr 24, 2018. It is now read-only.

Commit

Permalink
Release version 0.7.0
Browse files Browse the repository at this point in the history
- Remove Segment docs
- Remove Sublime project file
- Update package.json
- Add eslint
  • Loading branch information
Patrick Burtchaell committed Jun 3, 2015
1 parent 2a25935 commit 132979d
Show file tree
Hide file tree
Showing 6 changed files with 171 additions and 60 deletions.
155 changes: 155 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
{
"env": {
"browser": true,
"node": true,
"es6": true
},
"ecmaFeatures": {
"jsx": true,
"modules": true
},
"rules": {
"no-comma-dangle": 0,
"no-cond-assign": 2,
"no-console": 1,
"no-constant-condition": 2,
"no-control-regex": 2,
"no-debugger": 2,
"no-dupe-keys": 2,
"no-duplicate-case": 2,
"no-empty": 2,
"no-empty-class": 2,
"no-ex-assign": 2,
"no-extra-boolean-cast": 2,
"no-extra-parens": 2,
"no-extra-semi": 2,
"no-func-assign": 2,
"no-inner-declarations": 2,
"no-invalid-regexp": 2,
"no-irregular-whitespace": 2,
"no-negated-in-lhs": 2,
"no-obj-calls": 2,
"no-regex-spaces": 2,
"no-reserved-keys": 2,
"no-sparse-arrays": 2,
"no-unreachable": 2,
"use-isnan": 2,
"valid-jsdoc": 2,
"valid-typeof": 2,
"block-scoped-var": 2,
"complexity": 0,
"consistent-return": 2,
"curly": 2,
"default-case": 1,
"dot-notation": 0,
"eqeqeq": 1,
"guard-for-in": 1,
"no-alert": 1,
"no-caller": 2,
"no-div-regex": 2,
"no-else-return": 2,
"no-empty-label": 2,
"no-eq-null": 1,
"no-eval": 2,
"no-extend-native": 2,
"no-extra-bind": 2,
"no-fallthrough": 2,
"no-floating-decimal": 2,
"no-implied-eval": 2,
"no-iterator": 2,
"no-labels": 2,
"no-lone-blocks": 2,
"no-loop-func": 1,
"no-multi-spaces": 2,
"no-multi-str": 2,
"no-native-reassign": 2,
"no-new": 2,
"no-new-func": 2,
"no-new-wrappers": 2,
"no-octal": 2,
"no-octal-escape": 2,
"no-param-reassign": 2,
"no-proto": 2,
"no-redeclare": 1,
"no-return-assign": 2,
"no-script-url": 2,
"no-self-compare": 2,
"no-sequences": 2,
"no-unused-expressions": 2,
"no-void": 1,
"no-warning-comments": [1, { "terms": ["todo", "fixme"], "location": "start" }],
"no-with": 2,
"radix": 2,
"vars-on-top": 1,
"wrap-iife": [2, "any"],
"yoda": 0,
"strict": [0, "never"],
"no-catch-shadow": 2,
"no-delete-var": 2,
"no-label-var": 2,
"no-shadow": 2,
"no-shadow-restricted-names": 2,
"no-undef": 2,
"no-undef-init": 2,
"no-undefined": 1,
"no-unused-vars": 2,
"no-use-before-define": 2,
"handle-callback-err": 2,
"no-mixed-requires": 1,
"no-new-require": 2,
"no-path-concat": 2,
"no-process-exit": 2,
"no-restricted-modules": 0,
"no-sync": 0,
"indent": [2, 2],
"brace-style": [2, "1tbs", { "allowSingleLine": true }],
"camelcase": 1,
"comma-dangle": "always",
"comma-spacing": [2, { "before": false, "after": true }],
"comma-style": [2, "last"],
"consistent-this": 0,
"eol-last": 2,
"func-style": 0,
"key-spacing": [2, { "beforeColon": false, "afterColon": true }],
"max-nested-callbacks": 0,
"new-cap": 1,
"new-parens": 2,
"newline-after-var": [1, "always"],
"no-array-constructor": 2,
"no-inline-comments": 1,
"no-lonely-if": 1,
"no-mixed-spaces-and-tabs": 2,
"no-multiple-empty-lines": [2, { "max": 2 }],
"no-nested-ternary": 2,
"no-new-object": 2,
"no-spaced-func": 2,
"no-ternary": 0,
"no-trailing-spaces": 2,
"no-underscore-dangle": 1,
"no-wrap-func": 2,
"one-var": 0,
"operator-assignment": 0,
"padded-blocks": 0,
"quote-props": 0,
"quotes": [2, "single", "avoid-escape"],
"semi": [2, "always"],
"semi-spacing": [2, {"before": false, "after": true}],
"sort-vars": 0,
"space-after-keywords": [2, "always"],
"space-before-blocks": [2, "always"],
"space-before-function-paren": [2, {"anonymous": "never", "named": "always"}],
"space-in-brackets": 0,
"space-in-parens": 0,
"space-infix-ops": 2,
"space-return-throw-case": 2,
"space-unary-ops": [1, { "words": true, "nonwords": false }],
"spaced-line-comment": [2, "always", { "exceptions": ["-"] }],
"wrap-regex": 1,
"max-depth": 0,
"max-len": [1, 100, 4],
"max-params": [1, 3],
"max-statements": 0,
"no-bitwise": 1,
"no-plusplus": 0
}
}
12 changes: 0 additions & 12 deletions .sublime-project

This file was deleted.

8 changes: 8 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
language: node_js
node_js:
- '0.11'
branches:
only:
- master
install:
- npm install
46 changes: 6 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# Segment API
# Sails.js Example REST API

## Overview

Segment is powered by [Sails](http://sailsjs.org/), a MVC framework for Node.js, and MongoDB.
[Sails](http://sailsjs.org/), a MVC framework for Node.js, and MongoDB.

## Development

Expand All @@ -11,7 +9,7 @@ Segment is powered by [Sails](http://sailsjs.org/), a MVC framework for Node.js,

### Databases

Segment uses MongoDB for models and Redis for session and sockets stores.
This example uses MongoDB for models and Redis for session and sockets stores.

When Sails is run locally, it will connect to local Redis and MongoDB databases using the default settings. Should you have any issues, you can create and edit `config/local.js` to override the default config and use your own. These settings take precedence over all other config files, including those in the `config/env` subfolder.

Expand Down Expand Up @@ -39,42 +37,11 @@ module.exports = {

For more, see the Sails.js [configuration documentation](http://sailsjs.org/#/documentation/reference/sails.config/sails.config.local.html).

### Tools

- [WebPack](http://webpack.github.io/): JavaScript and CSS module bundler.
- [gulp](http://gulpjs.com/): Streaming build system and workflow automation.

### Features

> Developing software often involves teams of people working together. As the team grows from one, to two, to multiple people, challenges begin to creep in and rob the organization of creative flow. It becomes harder to maintain a continuous culture across different people. Engineering groups are especially prone to these challenges as code is routinely shared between many people throughout the organization. Code reviews help spread knowledge and best practices around code across the team. In this article we’ll take a look at why code reviews are important, and how to optimize the practice.
> [Every Team Needs Kick Ass Code Reviews](http://blogs.atlassian.com/2014/03/every-team-needs-kick-ass-code-reviews/)
Each new feature should be created on a separate branch and merged into master after a code review. Here is how we add new features at Segment:

1. Create new branch: `git branch feature-name`
2. Checkout the branch: `git checkout feature-name`
3. Add feature.
4. Add unit test(s).
5. Push to GitHub: `git push`
6. Create a pull request and ask for code review.
7. After the code review, the reviewer merges the branch into master.
8. Bump version number.

### Versioning

Segment uses [Semantic Versioning](http://semver.org/). Version tags can be created [on GitHub](https://github.com/pburtchaell/segment.social/releases/new).

Given a version number MAJOR.MINOR.PATCH, increment the:

1. MAJOR version when you make incompatible API changes,
2. MINOR version when you add functionality in a backwards-compatible manner, and
3. PATCH version when you make backwards-compatible bug fixes.

## Deployment

Segment is deployed to an instance on Heroku, an application platform. If this is your first time deploying the app, follow steps 1-6. Otherwise, just skip to step 4. For more, see the [Heroku Documentation on Node.js applications](https://devcenter.heroku.com/articles/getting-started-with-nodejs#introduction).
Sails is deployed to an instance on Heroku, an application platform. If this is your first time deploying the app, follow steps 1-6. Otherwise, just skip to step 4. For more, see the [Heroku Documentation on Node.js applications](https://devcenter.heroku.com/articles/getting-started-with-nodejs#introduction).

1. Create new app: `heroku create segment`
1. Create new app: `heroku create app-name`
2. Add Redis: `heroku addons:add redistogo`
3. Add MongoDB: `heroku addons:add mongolab`
4. Deploy the app: `git push heroku master`
Expand Down Expand Up @@ -120,7 +87,6 @@ PUT : /:controller/update/:id => update(id)
DELETE: /:controller/destroy/:id => destroy(id)
# You can also explicitly state the action
>>>>>>> image-api
GET : /:controller/find => findAll()
GET : /:controller/find/:id => find(id)
POST : /:controller/create => create(id)
Expand All @@ -129,4 +95,4 @@ DELETE: /:controller/destroy/:id => destroy(id)
```

---
Copyright 2015 Segment. All rights reserved.
Copyright 2015 Lawn Chair Studios. All rights reserved.
2 changes: 1 addition & 1 deletion newrelic.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ exports.config = {
* issues with the agent, 'info' and higher will impose the least overhead on
* production applications.
*/
level: 'trace'
level: 'trace'
}

};
8 changes: 1 addition & 7 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
{
"name": "api.segment",
"version": "0.6.0",
"description": "",
"version": "0.7.0",
"private": true,
"author": "",
"main": "app.js",
"scripts": {
"test": "",
"postinstall": "",
"start": "sails lift",
"watch": "nodemon --exec \"sails lift\"",
"start": "node app.js"
Expand Down

0 comments on commit 132979d

Please sign in to comment.