-
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
Stoyan Delev
committed
Jan 13, 2018
0 parents
commit 3a7e746
Showing
24 changed files
with
2,998 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,23 @@ | ||
{ | ||
"projectName": "worker-store", | ||
"projectOwner": "kentcdodds", | ||
"files": [ | ||
"README.md" | ||
], | ||
"imageSize": 100, | ||
"commit": false, | ||
"contributors": [ | ||
{ | ||
"login": "kentcdodds", | ||
"name": "Kent C. Dodds", | ||
"avatar_url": "https://avatars.githubusercontent.com/u/1500684?v=3", | ||
"profile": "https://kentcdodds.com", | ||
"contributions": [ | ||
"code", | ||
"doc", | ||
"infra", | ||
"test" | ||
] | ||
} | ||
] | ||
} |
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 |
---|---|---|
@@ -0,0 +1,2 @@ | ||
* text=auto | ||
*.js text eol=lf |
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 |
---|---|---|
@@ -0,0 +1,43 @@ | ||
<!-- | ||
Thanks for your interest in the project. I appreciate bugs filed and PRs submitted! | ||
Please make sure that you are familiar with and follow the Code of Conduct for | ||
this project (found in the CODE_OF_CONDUCT.md file). | ||
Please fill out this template with all the relevant information so we can | ||
understand what's going on and fix the issue. | ||
I'll probably ask you to submit the fix (after giving some direction). If you've | ||
never done that before, that's great! Check this free short video tutorial to | ||
learn how: http://kcd.im/pull-request | ||
--> | ||
|
||
- `worker-store` version: | ||
- `node` version: | ||
- `npm` (or `yarn`) version: | ||
|
||
Relevant code or config | ||
|
||
```javascript | ||
|
||
``` | ||
|
||
What you did: | ||
|
||
|
||
|
||
What happened: | ||
|
||
<!-- Please provide the full error message/screenshots/anything --> | ||
|
||
Reproduction repository: | ||
|
||
<!-- | ||
If possible, please create a repository that reproduces the issue with the | ||
minimal amount of code possible. | ||
--> | ||
|
||
Problem description: | ||
|
||
|
||
|
||
Suggested solution: |
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 |
---|---|---|
@@ -0,0 +1,35 @@ | ||
<!-- | ||
Thanks for your interest in the project. Bugs filed and PRs submitted are appreciated! | ||
Please make sure that you are familiar with and follow the Code of Conduct for | ||
this project (found in the CODE_OF_CONDUCT.md file). | ||
Also, please make sure you're familiar with and follow the instructions in the | ||
contributing guidelines (found in the CONTRIBUTING.md file). | ||
If you're new to contributing to open source projects, you might find this free | ||
video course helpful: http://kcd.im/pull-request | ||
Please fill out the information below to expedite the review and (hopefully) | ||
merge of your pull request! | ||
--> | ||
|
||
<!-- What changes are being made? (What feature/bug is being fixed here?) --> | ||
**What**: | ||
|
||
<!-- Why are these changes necessary? --> | ||
**Why**: | ||
|
||
<!-- How were these changes implemented? --> | ||
**How**: | ||
|
||
<!-- Have you done all of these things? --> | ||
**Checklist**: | ||
<!-- add "N/A" to the end of each line that's irrelevant to your changes --> | ||
<!-- to check an item, place an "x" in the box like so: "- [x] Documentation" --> | ||
- [ ] Documentation | ||
- [ ] Tests | ||
- [ ] Ready to be merged <!-- In your opinion, is this ready to be merged as soon as it's reviewed? --> | ||
- [ ] Added myself to contributors table <!-- this is optional, see the contributing guidelines for instructions --> | ||
|
||
<!-- feel free to add additional comments --> |
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 |
---|---|---|
@@ -0,0 +1,12 @@ | ||
node_modules | ||
coverage | ||
dist | ||
.opt-in | ||
.opt-out | ||
.DS_Store | ||
.eslintcache | ||
|
||
# these cause more harm than good | ||
# when working with contributors | ||
package-lock.json | ||
yarn.lock |
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 |
---|---|---|
@@ -0,0 +1,2 @@ | ||
registry=http://registry.npmjs.org/ | ||
package-lock=false |
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 |
---|---|---|
@@ -0,0 +1,13 @@ | ||
sudo: false | ||
language: node_js | ||
cache: | ||
directories: | ||
- ~/.npm | ||
notifications: | ||
email: false | ||
node_js: '8' | ||
install: npm install | ||
script: npm run validate | ||
after_success: kcd-scripts travis-after-success | ||
branches: | ||
only: master |
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 |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# CHANGELOG | ||
|
||
The changelog is automatically updated using [semantic-release](https://github.com/semantic-release/semantic-release). | ||
You can see it on the [releases page](../../releases). |
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 |
---|---|---|
@@ -0,0 +1,72 @@ | ||
# Contributing | ||
|
||
Thanks for being willing to contribute! | ||
|
||
**Working on your first Pull Request?** You can learn how from this *free* series | ||
[How to Contribute to an Open Source Project on GitHub][egghead] | ||
|
||
## Project setup | ||
|
||
1. Fork and clone the repo | ||
2. Run `npm run setup -s` to install dependencies and run validation | ||
3. Create a branch for your PR with `git checkout -b pr/your-branch-name` | ||
|
||
> Tip: Keep your `master` branch pointing at the original repository and make | ||
> pull requests from branches on your fork. To do this, run: | ||
> | ||
> ``` | ||
> git remote add upstream https://github.com/kentcdodds/worker-store.git | ||
> git fetch upstream | ||
> git branch --set-upstream-to=upstream/master master | ||
> ``` | ||
> | ||
> This will add the original repository as a "remote" called "upstream," | ||
> Then fetch the git information from that remote, then set your local `master` | ||
> branch to use the upstream master branch whenever you run `git pull`. | ||
> Then you can make all of your pull request branches based on this `master` | ||
> branch. Whenever you want to update your version of `master`, do a regular | ||
> `git pull`. | ||
## Add yourself as a contributor | ||
This project follows the [all contributors][all-contributors] specification. | ||
To add yourself to the table of contributors on the `README.md`, please use the | ||
automated script as part of your PR: | ||
```console | ||
npm run add-contributor | ||
``` | ||
Follow the prompt and commit `.all-contributorsrc` and `README.md` in the PR. | ||
If you've already added yourself to the list and are making | ||
a new type of contribution, you can run it again and select the added | ||
contribution type. | ||
|
||
## Committing and Pushing changes | ||
|
||
Please make sure to run the tests before you commit your changes. You can run | ||
`npm run test:update` which will update any snapshots that need updating. | ||
Make sure to include those changes (if they exist) in your commit. | ||
|
||
### opt into git hooks | ||
|
||
There are git hooks set up with this project that are automatically installed | ||
when you install dependencies. They're really handy, but are turned off by | ||
default (so as to not hinder new contributors). You can opt into these by | ||
creating a file called `.opt-in` at the root of the project and putting this | ||
inside: | ||
|
||
``` | ||
pre-commit | ||
``` | ||
|
||
## Help needed | ||
|
||
Please checkout the [the open issues][issues] | ||
|
||
Also, please watch the repo and respond to questions/bug reports/feature | ||
requests! Thanks! | ||
|
||
[egghead]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github | ||
[all-contributors]: https://github.com/kentcdodds/all-contributors | ||
[issues]: https://github.com/kentcdodds/worker-store/issues |
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 |
---|---|---|
@@ -0,0 +1,20 @@ | ||
The MIT License (MIT) | ||
Copyright (c) 2017 Kent C. Dodds | ||
|
||
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. |
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 |
---|---|---|
@@ -0,0 +1,114 @@ | ||
<div align="center"> | ||
<h1>worker-store</h1> | ||
|
||
<p>Redux like store running in webworker</p> | ||
</div> | ||
|
||
<hr /> | ||
|
||
[![Build Status][build-badge]][build] | ||
[![Code Coverage][coverage-badge]][coverage] | ||
[![version][version-badge]][package] | ||
[![downloads][downloads-badge]][npmtrends] | ||
[![MIT License][license-badge]][LICENSE] | ||
|
||
[](#contributors) | ||
[![PRs Welcome][prs-badge]][prs] | ||
[![Code of Conduct][coc-badge]][coc] | ||
|
||
[![Watch on GitHub][github-watch-badge]][github-watch] | ||
[![Star on GitHub][github-star-badge]][github-star] | ||
[![Tweet][twitter-badge]][twitter] | ||
|
||
<a href="https://app.codesponsor.io/link/PKGFLnhDiFvsUA5P4kAXfiPs/kentcdodds/worker-store" rel="nofollow"><img src="https://app.codesponsor.io/embed/PKGFLnhDiFvsUA5P4kAXfiPs/kentcdodds/worker-store.svg" style="width: 888px; height: 68px;" alt="Sponsor" /></a> | ||
|
||
## The problem | ||
|
||
// TODO | ||
|
||
## This solution | ||
|
||
// TODO | ||
|
||
## Table of Contents | ||
|
||
<!-- START doctoc generated TOC please keep comment here to allow auto update --> | ||
<!-- DON'T EDIT THIS SECTION. It'll update automatically --> | ||
|
||
- [Installation](#installation) | ||
- [Usage](#usage) | ||
- [Props](#props) | ||
- [Control Props](#control-props) | ||
- [Child Callback Function](#child-callback-function) | ||
- [Examples](#examples) | ||
- [FAQ](#faq) | ||
- [Inspiration](#inspiration) | ||
- [Other Solutions](#other-solutions) | ||
- [Contributors](#contributors) | ||
- [LICENSE](#license) | ||
|
||
<!-- END doctoc generated TOC please keep comment here to allow auto update --> | ||
|
||
## Installation | ||
|
||
This module is distributed via [npm][npm] which is bundled with [node][node] and | ||
should be installed as one of your project's `dependencies`: | ||
|
||
``` | ||
npm install --save worker-store | ||
``` | ||
|
||
## Usage | ||
|
||
// TODO | ||
|
||
## Inspiration | ||
|
||
// TODO | ||
|
||
## Other Solutions | ||
|
||
I'm not aware of any, if you are please [make a pull request][prs] and add it | ||
here! | ||
|
||
## Contributors | ||
|
||
Thanks goes to these people ([emoji key][emojis]): | ||
|
||
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> | ||
| [<img src="https://avatars.githubusercontent.com/u/1500684?v=3" width="100px;"/><br /><sub>Kent C. Dodds</sub>](https://kentcdodds.com)<br />[💻](https://github.com/kentcdodds/worker-store/commits?author=kentcdodds) [📖](https://github.com/kentcdodds/worker-store/commits?author=kentcdodds) 🚇 [⚠️](https://github.com/kentcdodds/worker-store/commits?author=kentcdodds) | | ||
| :---: | | ||
<!-- ALL-CONTRIBUTORS-LIST:END --> | ||
|
||
This project follows the [all-contributors][all-contributors] specification. | ||
Contributions of any kind welcome! | ||
|
||
## LICENSE | ||
|
||
MIT | ||
|
||
[npm]: https://www.npmjs.com/ | ||
[node]: https://nodejs.org | ||
[build-badge]: https://img.shields.io/travis/kentcdodds/worker-store.svg?style=flat-square | ||
[build]: https://travis-ci.org/kentcdodds/worker-store | ||
[coverage-badge]: https://img.shields.io/codecov/c/github/kentcdodds/worker-store.svg?style=flat-square | ||
[coverage]: https://codecov.io/github/kentcdodds/worker-store | ||
[version-badge]: https://img.shields.io/npm/v/worker-store.svg?style=flat-square | ||
[package]: https://www.npmjs.com/package/worker-store | ||
[downloads-badge]: https://img.shields.io/npm/dm/worker-store.svg?style=flat-square | ||
[npmtrends]: http://www.npmtrends.com/worker-store | ||
[license-badge]: https://img.shields.io/npm/l/worker-store.svg?style=flat-square | ||
[license]: https://github.com/kentcdodds/worker-store/blob/master/LICENSE | ||
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square | ||
[prs]: http://makeapullrequest.com | ||
[donate-badge]: https://img.shields.io/badge/$-support-green.svg?style=flat-square | ||
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square | ||
[coc]: https://github.com/kentcdodds/worker-store/blob/master/other/CODE_OF_CONDUCT.md | ||
[github-watch-badge]: https://img.shields.io/github/watchers/kentcdodds/worker-store.svg?style=social | ||
[github-watch]: https://github.com/kentcdodds/worker-store/watchers | ||
[github-star-badge]: https://img.shields.io/github/stars/kentcdodds/worker-store.svg?style=social | ||
[github-star]: https://github.com/kentcdodds/worker-store/stargazers | ||
[twitter]: https://twitter.com/intent/tweet?text=Check%20out%20worker-store%20by%20%40kentcdodds%20https%3A%2F%2Fgithub.com%2Fkentcdodds%2Fworker-store%20%F0%9F%91%8D | ||
[twitter-badge]: https://img.shields.io/twitter/url/https/github.com/kentcdodds/worker-store.svg?style=social | ||
[emojis]: https://github.com/kentcdodds/all-contributors#emoji-key | ||
[all-contributors]: https://github.com/kentcdodds/all-contributors |
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 |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# See https://help.github.com/ignore-files/ for more about ignoring files. | ||
|
||
# dependencies | ||
/node_modules | ||
|
||
# testing | ||
/coverage | ||
|
||
# production | ||
/build | ||
|
||
# misc | ||
.DS_Store | ||
.env.local | ||
.env.development.local | ||
.env.test.local | ||
.env.production.local | ||
|
||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* |
Oops, something went wrong.