giosgSDK - Simplicity on your fingertips :rocket:

The giosgSDK provides an hassle free way to implement giosg products to your products. GiosgSDK contains all giosg API's and SDK's in one place.

Features

The selected list of features will be announced later.

Usage

Install by running npm install --save github:giosg/giosgSDK#<commit_hash>

More in-depth documentation coming later.

Happy developing :tada:

Development

Development tips and tricks.

1. Clone the repository to your machine.
2. Install dependencies by running npm install
3. Now you are ready!

If you are working a feature which needs changes to giosgSDK and another app please check the commands npm link and npm pack to achieve more fluid development process.

Publishing

NOTE: This package is currently under development and is not yet released to NPM.

Before publishing, remember to consider the effects your changes have for our users. See semantic versioning.

1. Update CHANGELOG.md and update package version (e.g. with npm --no-git-tag-version version <major|minor|patch>), and commit.
2. Create pull request.
3. Request a review from another experienced developer.
4. Merge the pull request after approval and passed tests.

No need to push to NPM yet as projects using this package will install it like this: npm install --save github:giosg/giosgSDK#<commit_hash>.

Recommended VSCode extensions

Recommended extensions are listed in ./vscode/extensions.json file.

Eslint

Eslint is used to improve code quality across whole codebase. VSCode will start showing useful warnings and errors, which in most of the cases you should try to fix. Install this extension: dbaeumer.vscode-eslint.

To run eslint execute command npm run lint and to fix linting errors execute npm run lint-fix

Prettier

Prettier enforces a consistent style by parsing code and reprinting it with its own rules. The VSCode is configured to format code on every save. You need to install the extension esbenp.prettier-vscode.

To run prettier execute command npm run prettier and to fix prettier errors execute npm run prettier-fix

Code Spell Checker

Just do some spell check in code streetsidesoftware.code-spell-checker.

GitLens — Git supercharged

Show hints about git history for each line eamodio.gitlens.

Markdown lint

Help for markdown davidanson.vscode-markdownlint.

Visual Studio IntelliCode - Preview

Visual Studio IntelliCode (IntelliCode) is a set of AI-assisted capabilities that improve developer productivity with features like contextual IntelliSense, code formatting and style rule inference.

Import Cost

Show approximated size of imported modules wix.vscode-import-cost.

Tests

To run tests. Run command npm run test.