Veoci Typescript API

Purpose

This is a set of classes modeled after Firebase's semantic API conventions to make working with the Veoci API as easy as possible in the client. The goal of the project was to create a very simple API wrapper that read like a sentance.

There are three available API modules referring to the three different Veoci API versions that you can access. NOTE: only v1 and v2 are accessible from mobile projects due to authentication issues with web.

  this.$veocijs.api.web
  this.$veocijs.api.v1
  this.$veocijs.api.v2

Importing library

You can import the generated bundle to use the whole library generated by this starter:

import API from 'veoci-js'

Additionally, you can import the transpiled modules from dist/es in case you have a modular library:

import something from 'veoci-js/dist/es/something'

NPM scripts

• yarn t: Run test suite
• yarn start or yarn dev: Run npm run build in watch mode
• yarn test:watch: Run test suite in interactive watch mode
• yarn test:prod: Run linting and generate coverage
• yarn build: Generate bundles and typings, create docs
• yarn lint: Lints code
• yarn commit: Commit using conventional commit style (husky will tell you to use it if you haven't :wink:)

Working Locally

You can set your project up to use this repo by using the yarn link functionality. Once linked, you need to then run yarn start. GEOFF'S NOTE: I've had issues with the watcher. It's flaky. What I have found is running yarn start the first time does recompile the stuff, and your first change after will also recompile. However, the next change doesn't trigger the build so you need to manually restart. A bummer, but I haven't had time to figure out why that's happening yet. This project doesn't change that frequently so not a huge deal.

Automatic releases

NOTE: DISABLED AT THE MOMENT

Prerequisites: you need to create/login accounts and add your project to:

• npm
• Circle CI
• Coveralls

Prerequisite for Windows: Semantic-release uses node-gyp so you will need to install Microsoft's windows-build-tools using this command:

npm install --global --production windows-build-tools

Git Hooks

There is already set a precommit hook for formatting your code with Prettier :nail_care:

By default, there are two disabled git hooks. They're set up when you run the npm run semantic-release-prepare script. They make sure:

• You follow a conventional commit message
• Your build is not going to fail in Travis (or your CI server), since it's runned locally before git push

This makes more sense in combination with automatic releases