https://github.com/hackthevalley/js_sdk
Hack the Valley JavaScript SDK
https://github.com/hackthevalley/js_sdk
graphql javascript sdk
Last synced: about 2 months ago
JSON representation
Hack the Valley JavaScript SDK
- Host: GitHub
- URL: https://github.com/hackthevalley/js_sdk
- Owner: hackthevalley
- Created: 2018-08-24T12:20:00.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-01-15T14:25:00.000Z (over 7 years ago)
- Last Synced: 2025-07-07T16:47:01.836Z (12 months ago)
- Topics: graphql, javascript, sdk
- Language: JavaScript
- Homepage: https://hackthevalley.github.io/js_sdk/
- Size: 810 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hack the Valley JavaScript SDK
Interested in building with Hack the Valley API? Download our JS SDK to get started!
```bash
$ npm install @hackthevalley/sdk --save
```
Once you have installed the SDK, import it by simply typing:
```js
import htv from '@hackthevalley/sdk';
```
You can find the API reference here: https://hackthevalley.github.io/js_sdk/.
## Contributing
Feel free to contribute to this repository, there isn't really any style guidelines, once you read through the codebase everything should be very self-explanatory.
Note that we use Flow to do static type checking, you can manually run `npm test` to check types. There is also a pre-commit hook where we automatically checks the typing for you.
## Deployment
To deploy a new version of the documentation, run
```
$ npm run deploy-doc
```
To deploy a new version to NPM, run
```
$ npm run deploy:(patch|minor|major)
```