Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stevehanson committed Jan 11, 2019
0 parents commit 582a24c
Show file tree
Hide file tree
Showing 3 changed files with 88 additions and 0 deletions.
19 changes: 19 additions & 0 deletions LICENSE
@@ -0,0 +1,19 @@
Copyright (c) 2019 Stephen Hanson and thoughtbot, 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.
50 changes: 50 additions & 0 deletions README.md
@@ -0,0 +1,50 @@
# Fishery

Fishery is a library for setting up JavaScript objects for use in tests. It is modeled after the Ruby gem, [Factory Bot][factory_bot].

Fishery is built with TypeScript in mind, so your factories will always return typed objects. If you aren't using TypeScript, that's fine too -- Fishery will still work, just without the extra typechecking that comes with TypeScript.

### Getting Started

```
npm install --save fishery
```

or

```
yarn add fishery
```

### Usage

TODO

### Contributing

TODO

### Credits

TODO

### License

Fishery is Copyright © 2019 Stephen Hanson and thoughtbot. It is free
software, and may be redistributed under the terms specified in the
[LICENSE](/LICENSE) file.

### About thoughtbot

![thoughtbot](https://presskit.thoughtbot.com/images/thoughtbot-logo-for-readmes.svg)

Fishery is maintained and funded by thoughtbot, inc.
The names and logos for thoughtbot are trademarks of thoughtbot, inc.

We love open source software!
See [our other projects][community] or
[hire us][hire] to design, develop, and grow your product.

[community]: https://thoughtbot.com/community?utm_source=github
[hire]: https://thoughtbot.com/hire-us?utm_source=github
[factory_bot]: https://github.com/thoughtbot/factory_bot
19 changes: 19 additions & 0 deletions package.json
@@ -0,0 +1,19 @@
{
"name": "fishery",
"version": "0.0.1",
"description": "A library for setting up JavaScript objects as test data",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": "git+https://github.com/thoughtbot/fishery.git"
},
"author": "Stephen Hanson",
"license": "MIT",
"bugs": {
"url": "https://github.com/thoughtbot/fishery/issues"
},
"homepage": "https://github.com/thoughtbot/fishery#readme"
}

0 comments on commit 582a24c

Please sign in to comment.