Skip to content

Commit

Permalink
Hello, Version 4
Browse files Browse the repository at this point in the history
  • Loading branch information
dustinlarimer committed Aug 25, 2017
0 parents commit a833888
Show file tree
Hide file tree
Showing 58 changed files with 34,026 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .bowerrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"directory": "./bower_components"
}
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
*.log
.DS_Store
.tmp
.awspublish-*
bower_components
node_modules
test/keen-unit-all.js
test/unit/build/*
16 changes: 16 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
.bowerrc
.DS_Store
.git*
*.log
*.md
*.yml
.tmp*
.awspublish-*

bower.json
gulpfile.js
karma.conf.js

bower_components
docs
test
23 changes: 23 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
language: node_js
node_js:
- "4.0"
branches:
only:
- master
env:
global:
- secure: |-
Gz4y8zxEhPJVGfAq7UROzXS0qo9RyKFfc4hsJHy5hWBbTVCoe7BvcxtOfHkF
6DG246MPtxvkZsqaqPUJ55eg+ED+GTyG7lWsKJb9TA/8QtqKlHSyaW9pKZgi
Nwx1a9i7wGMCQ2GQ58KOHVAx33wpf3TVvXyEdxXNeLxDhAqlA1U=
- secure: |-
AjvRPOjPEuDl8qwEUOk2V1HH6C5AoE8V0/1+twsnaEcgfHWGDk3g7oPfMOW3
ArybZFvN+wpvWfwoJAhRV7yQv9yoGT1fEtMtn3GB9mQiCFO70L/MrqXePJAr
ajs3LH0wqhj1zW8UUmhTxBSLvzRyW++W5yx2hYr92EkrlpFZZUg=
install:
- npm install -g browserify
- npm install -g bower
- npm install
- bower install
notifications:
email: never
22 changes: 22 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<!--
<a name="unreleased"></a>
# Unreleased
-->
<a name="4.0.0"></a>
# Hello, version 4

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

**Stream: [keen-tracking.js](https://github.com/keen/keen-tracking.js)**
[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)
_What to expect: One breaking change to a utility method, otherwise a full drop-in replacement._

**Compute: [keen-analysis.js](https://github.com/keen/keen-analysis.js)**
[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)
_What to expect: Several breaking changes, significant rework of HTTP methods, and a much better interface for handling requests for all API resources._

**Visualize: [keen-dataviz.js](https://github.com/keen/keen-dataviz.js)**
[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)
_What to expect: Several breaking changes, significant rework of internal props._

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.
78 changes: 78 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# Keen IO JavaScript Client

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.

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.

Improving documentation, bug triaging, building modules for various frameworks or writing tutorials are all examples of helpful contributions we really appreciate.

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 [email protected]

## Guidelines

* Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
* 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/).

## Your First Contribution

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

At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first :smile_cat:

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.

### Run the following commands to get this project set up locally.

```ssh
$ git clone https://github.com/keenlabs/keen-js.git && cd keen-js
$ npm install
$ bower install
# Build and launch project site
$ gulp
# Build and launch with tests
$ gulp with-tests
# View test results at http://localhost:9999
```

### Submitting a Pull Request

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.

```
## What does this PR do? How does it affect users?
## How should this be tested?
Step through the code line by line. Things to keep in mind as you review:
- Are there any edge cases not covered by this code?
- Does this code follow conventions (naming, formatting, modularization, etc) where applicable?
Fetch the branch and/or deploy to staging to test the following:
- [ ] Does the code compile without warnings (check shell, console)?
- [ ] Do all tests pass?
- [ ] Does the UI, pixel by pixel, look exactly as expected (check various screen sizes, including mobile)?
- [ ] If the feature makes requests from the browser, inspect them in the Web Inspector. Do they look as expected (parameters, headers, etc)?
- [ ] If the feature sends data to Keen, is the data visible in the project if you run an extraction (include link to collection/query)?
- [ ] If the feature saves data to a database, can you confirm the data is indeed created in the database?
## Related tickets?
```

## How to report a bug
If you find a security vulnerability, do NOT open an issue. Email [email protected] instead.

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.

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!

## Suggesting features

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 [email protected] and we will make sure and get you in touch with the product team.

# Code review process

The core team looks at Pull Requests and issues on a regular basis and will typically respond within 5 business days.
52 changes: 52 additions & 0 deletions DEPLOYING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# How to deploy keen.js

## Preparing the release

1. Be certain that `version` has been updated in `package.json`.
2. Create a new `CHANGELOG.md` entry with information about this release ([example](https://github.com/keen/keen-js/blob/431c24b44047adec449184fba0b6a22ca9fdb129/CHANGELOG.md)).
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.
4. Commit updates from these steps now.
5. Be certain to run `gulp build` so that the files you commit and deploy from `./dist` are in fact the latest and greatest.

## Cutting the release

* Force-add the `dist` folder: `git add .dist/ -f`
* Commit this: `git commit -m "v{version} release"`
* Create a new tag: `git tag v{version}` (ex: v3.3.1)
* Push this tag: `git push origin v{version}` (ex: v3.3.1)

_Need a do-over? Tags can be overwritten with the `-f` flag._

## Verify the release

* [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...

## Deploying to NPM

**Beware: this is a one-time deal. Releases cannot be re-published!**

* Deploy this tag the npm: `npm publish`

## Deploying to AWS:

Run this command with the appropriate AWS and aws_secret keys:

```ssh
$ export AWS_KEY={AWS KEY}
$ export AWS_SECRET={AWS SECRET}
$ gulp deploy
```

This will test, build, and deploy the files to AWS.

This [blog post](https://viget.com/extend/publishing-packages-to-npm-and-bower) was especially helpful with information on
publishing to `npm` and `bower`.

## One last step!

Now that you've finished, un-commit the `dist/` folder.

```ssh
git reset --soft HEAD~1
git rm --cached ./dist
```
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2014 KEEN IO, Inc

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

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

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

0 comments on commit a833888

Please sign in to comment.