Skip to content

Commit a833888

Browse files
committed
Hello, Version 4
0 parents  commit a833888

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+34026
-0
lines changed

.bowerrc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"directory": "./bower_components"
3+
}

.gitignore

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
*.log
2+
.DS_Store
3+
.tmp
4+
.awspublish-*
5+
bower_components
6+
node_modules
7+
test/keen-unit-all.js
8+
test/unit/build/*

.npmignore

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.bowerrc
2+
.DS_Store
3+
.git*
4+
*.log
5+
*.md
6+
*.yml
7+
.tmp*
8+
.awspublish-*
9+
10+
bower.json
11+
gulpfile.js
12+
karma.conf.js
13+
14+
bower_components
15+
docs
16+
test

.travis.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
language: node_js
2+
node_js:
3+
- "4.0"
4+
branches:
5+
only:
6+
- master
7+
env:
8+
global:
9+
- secure: |-
10+
Gz4y8zxEhPJVGfAq7UROzXS0qo9RyKFfc4hsJHy5hWBbTVCoe7BvcxtOfHkF
11+
6DG246MPtxvkZsqaqPUJ55eg+ED+GTyG7lWsKJb9TA/8QtqKlHSyaW9pKZgi
12+
Nwx1a9i7wGMCQ2GQ58KOHVAx33wpf3TVvXyEdxXNeLxDhAqlA1U=
13+
- secure: |-
14+
AjvRPOjPEuDl8qwEUOk2V1HH6C5AoE8V0/1+twsnaEcgfHWGDk3g7oPfMOW3
15+
ArybZFvN+wpvWfwoJAhRV7yQv9yoGT1fEtMtn3GB9mQiCFO70L/MrqXePJAr
16+
ajs3LH0wqhj1zW8UUmhTxBSLvzRyW++W5yx2hYr92EkrlpFZZUg=
17+
install:
18+
- npm install -g browserify
19+
- npm install -g bower
20+
- npm install
21+
- bower install
22+
notifications:
23+
email: never

CHANGELOG.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!--
2+
<a name="unreleased"></a>
3+
# Unreleased
4+
-->
5+
<a name="4.0.0"></a>
6+
# Hello, version 4
7+
8+
This release replaces all functionality found in v3 with three standalone modules, listed below, as a bundled distribution. Documentation, bug tracking, and feature development will continue to reside in each module's respective repo. [Read about getting started here](https://github.com/keen/keen-js/tree/master#getting-started).
9+
10+
**Stream: [keen-tracking.js](https://github.com/keen/keen-tracking.js)**
11+
[Documentation](https://github.com/keen/keen-tracking.js/blob/master/README.md) | [Issues](https://github.com/keen/keen-tracking.js/issues) | [Upgrade guide](https://github.com/keen/keen-tracking.js/blob/master/docs/upgrade-guide.md)
12+
_What to expect: One breaking change to a utility method, otherwise a full drop-in replacement._
13+
14+
**Compute: [keen-analysis.js](https://github.com/keen/keen-analysis.js)**
15+
[Documentation](https://github.com/keen/keen-analysis.js/blob/master/README.md) | [Issues](https://github.com/keen/keen-analysis.js/issues) | [Upgrade guide](https://github.com/keen/keen-analysis.js#upgrading-from-keen-js)
16+
_What to expect: Several breaking changes, significant rework of HTTP methods, and a much better interface for handling requests for all API resources._
17+
18+
**Visualize: [keen-dataviz.js](https://github.com/keen/keen-dataviz.js)**
19+
[Documentation](https://github.com/keen/keen-dataviz.js/tree/master/docs) | [Issues](https://github.com/keen/keen-dataviz.js/issues) | [Examples](http://keen.github.io/keen-dataviz.js/) | [Upgrade guide](https://github.com/keen/keen-dataviz.js#upgrading-from-keen-js)
20+
_What to expect: Several breaking changes, significant rework of internal props._
21+
22+
When **keen-js** is loaded as a global, these packages will be assigned to a shared `Keen` namespace. If you only need select functionality, we recommend using the standalone packages, which can each installed independently, via npm.

CONTRIBUTING.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Keen IO JavaScript Client
2+
3+
First off, thank you for considering contributing to this official Keen IO client. It's people like you that make Keen IO such a great tool.
4+
5+
We put these guidelines together to try and make working with our SDK as straight forward as possible, and hopefully help you understand how we communicate about potential changes and improvements.
6+
7+
Improving documentation, bug triaging, building modules for various frameworks or writing tutorials are all examples of helpful contributions we really appreciate.
8+
9+
Please, don't use the issue tracker for support questions. If you have a support question please come hang out in http://keen.chat or send an email to team@keen.io
10+
11+
## Guidelines
12+
13+
* Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
14+
* Be welcoming to newcomers and encourage diverse new contributors from all backgrounds. See the [Python Community Code of Conduct](https://www.python.org/psf/codeofconduct/).
15+
16+
## Your First Contribution
17+
18+
Here are a couple of friendly tutorials with more information about contributing to OSS projects: http://makeapullrequest.com/, http://www.firsttimersonly.com/, and [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).
19+
20+
At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first :smile_cat:
21+
22+
If a maintainer asks you to "rebase" your PR, they're saying that a lot of code has changed, and that you need to update your branch so it's easier to merge.
23+
24+
### Run the following commands to get this project set up locally.
25+
26+
```ssh
27+
$ git clone https://github.com/keenlabs/keen-js.git && cd keen-js
28+
$ npm install
29+
$ bower install
30+
31+
# Build and launch project site
32+
$ gulp
33+
34+
# Build and launch with tests
35+
$ gulp with-tests
36+
37+
# View test results at http://localhost:9999
38+
```
39+
40+
### Submitting a Pull Request
41+
42+
Use the template below. If certain testing steps are not relevant, specify that in the PR. If additional checks are needed, add 'em! Please run through all testing steps before asking for a review.
43+
44+
```
45+
## What does this PR do? How does it affect users?
46+
47+
## How should this be tested?
48+
49+
Step through the code line by line. Things to keep in mind as you review:
50+
- Are there any edge cases not covered by this code?
51+
- Does this code follow conventions (naming, formatting, modularization, etc) where applicable?
52+
53+
Fetch the branch and/or deploy to staging to test the following:
54+
55+
- [ ] Does the code compile without warnings (check shell, console)?
56+
- [ ] Do all tests pass?
57+
- [ ] Does the UI, pixel by pixel, look exactly as expected (check various screen sizes, including mobile)?
58+
- [ ] If the feature makes requests from the browser, inspect them in the Web Inspector. Do they look as expected (parameters, headers, etc)?
59+
- [ ] If the feature sends data to Keen, is the data visible in the project if you run an extraction (include link to collection/query)?
60+
- [ ] If the feature saves data to a database, can you confirm the data is indeed created in the database?
61+
62+
## Related tickets?
63+
```
64+
65+
## How to report a bug
66+
If you find a security vulnerability, do NOT open an issue. Email team@keen.io instead.
67+
68+
If you find a bug that's not a security vulnerability please head over to the issues tab of this rep and open up an issue.
69+
70+
We created these labels to help us organize issues: bugs, docs, enhancements, and feature-request. Please use them when creating an issue where it makes sense!
71+
72+
## Suggesting features
73+
74+
We welcome your feedback and requests. If you have a straight forward request please open up an issue that details the request. If you want to talk to someone on the Keen team head over to http://keen.chat or send a note to team@keen.io and we will make sure and get you in touch with the product team.
75+
76+
# Code review process
77+
78+
The core team looks at Pull Requests and issues on a regular basis and will typically respond within 5 business days.

DEPLOYING.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# How to deploy keen.js
2+
3+
## Preparing the release
4+
5+
1. Be certain that `version` has been updated in `package.json`.
6+
2. Create a new `CHANGELOG.md` entry with information about this release ([example](https://github.com/keen/keen-js/blob/431c24b44047adec449184fba0b6a22ca9fdb129/CHANGELOG.md)).
7+
3. Update `README.md` `docs/README.md`, and `docs/installation.md` files to reflect what the new CDN URLs and library versions _will_ be once this release is live.
8+
4. Commit updates from these steps now.
9+
5. Be certain to run `gulp build` so that the files you commit and deploy from `./dist` are in fact the latest and greatest.
10+
11+
## Cutting the release
12+
13+
* Force-add the `dist` folder: `git add .dist/ -f`
14+
* Commit this: `git commit -m "v{version} release"`
15+
* Create a new tag: `git tag v{version}` (ex: v3.3.1)
16+
* Push this tag: `git push origin v{version}` (ex: v3.3.1)
17+
18+
_Need a do-over? Tags can be overwritten with the `-f` flag._
19+
20+
## Verify the release
21+
22+
* [Check the repo releases](https://github.com/keen/keen-js/releases) and download the ZIP file to ensure that the `dist` folder and built files are there. If so, continue...
23+
24+
## Deploying to NPM
25+
26+
**Beware: this is a one-time deal. Releases cannot be re-published!**
27+
28+
* Deploy this tag the npm: `npm publish`
29+
30+
## Deploying to AWS:
31+
32+
Run this command with the appropriate AWS and aws_secret keys:
33+
34+
```ssh
35+
$ export AWS_KEY={AWS KEY}
36+
$ export AWS_SECRET={AWS SECRET}
37+
$ gulp deploy
38+
```
39+
40+
This will test, build, and deploy the files to AWS.
41+
42+
This [blog post](https://viget.com/extend/publishing-packages-to-npm-and-bower) was especially helpful with information on
43+
publishing to `npm` and `bower`.
44+
45+
## One last step!
46+
47+
Now that you've finished, un-commit the `dist/` folder.
48+
49+
```ssh
50+
git reset --soft HEAD~1
51+
git rm --cached ./dist
52+
```

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2014 KEEN IO, Inc
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

0 commit comments

Comments
 (0)