Starling Developer SDK

https://github.com/starlingbank/starling-developer-sdk
Admin
The Starling Javascript SDK provides a convenient way for developers to interact with the Starling...
Tokens:869
Snippets:13
Trust Score:-
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Serving Local Documentation (Shell)

Source: https://github.com/starlingbank/starling-developer-sdk/blob/master/CONTRIBUTING.md

Starts a local Jekyll web server to preview the documentation content. This command should be run after installing the Ruby dependencies and allows contributors to see how their documentation changes will render.

```Shell
bundle exec jekyll serve
```

--------------------------------

### Initializing Starling Client and Fetching Accounts (Javascript)

Source: https://github.com/starlingbank/starling-developer-sdk/blob/master/README.md

This example shows how to initialize the Starling SDK client using an OAuth access token and perform a basic API call to retrieve account details. It demonstrates both CommonJS and ES module import styles. Requires the starling-developer-sdk package to be installed and a valid OAuth access token.

```javascript
const Starling = require('starling-developer-sdk')
// or
import Starling from 'starling-developer-sdk'

const client = new Starling({
  // apiUrl: 'https://api-sandbox.starlingbank.com',
  accessToken: '<oauth access token>'
})

client.account.getAccounts()
  .then(({ data }) => console.log(data))
  .catch(err => console.log(err))
```

--------------------------------

### Installing Ruby Dependencies for Docs (Shell)

Source: https://github.com/starlingbank/starling-developer-sdk/blob/master/CONTRIBUTING.md

Installs the necessary Ruby gems required for building and serving the documentation locally, specifically for the Jekyll-based documentation site. This command assumes Ruby and Bundler are installed.

```Shell
bundle install
```

--------------------------------

### Installing JavaScript Dependencies (Shell)

Source: https://github.com/starlingbank/starling-developer-sdk/blob/master/CONTRIBUTING.md

This command installs all the necessary Node.js packages and dependencies required for the project, as specified in the package.json file. It should be run after cloning the repository for the first time to set up the development environment.

```Shell
npm install
```

--------------------------------

### Installing Starling SDK with npm (Bash)

Source: https://github.com/starlingbank/starling-developer-sdk/blob/master/README.md

This snippet demonstrates how to install the Starling Developer SDK using the Node Package Manager (npm). It is a required prerequisite for using the SDK in a Node.js or browser environment. Requires Node.js and npm to be installed.

```bash
npm install starling-developer-sdk
```

--------------------------------

### Running Tests in Watch Mode (Shell)

Source: https://github.com/starlingbank/starling-developer-sdk/blob/master/CONTRIBUTING.md

Starts the test runner in watch mode. The tests automatically re-run whenever source files or test files are changed, providing rapid feedback during development.

```Shell
npm run test:dev
```

--------------------------------

### Building the SDK (Shell)

Source: https://github.com/starlingbank/starling-developer-sdk/blob/master/CONTRIBUTING.md

Compiles the project source code into a distributable format. This process typically involves transpilation, minification, and packaging files into a designated output directory.

```Shell
npm run build
```

--------------------------------

### Performing a Release (Shell)

Source: https://github.com/starlingbank/starling-developer-sdk/blob/master/CONTRIBUTING.md

Executes the project's release script, automating the process of creating a new version. The argument specifies the type of version bump according to Semantic Versioning (patch, minor, or major).

```Shell
./release.sh <patch | minor | major>
```

--------------------------------

### Running Tests with Verbose Output (Shell)

Source: https://github.com/starlingbank/starling-developer-sdk/blob/master/CONTRIBUTING.md

Executes the unit tests with verbose logging enabled. This provides more detailed output during test execution, which is helpful for debugging test failures.

```Shell
npm run test:verbose
```

--------------------------------

### Running Unit Tests (Shell)

Source: https://github.com/starlingbank/starling-developer-sdk/blob/master/CONTRIBUTING.md

Executes the project's automated unit test suite. This command is used to ensure that code changes pass all predefined tests and meet the required functional specifications before submitting a pull request.

```Shell
npm test
```

--------------------------------

### Checking Code Style and Linting (Shell)

Source: https://github.com/starlingbank/starling-developer-sdk/blob/master/CONTRIBUTING.md

Runs the project's linter to check for code style consistency, potential errors, and adherence to coding standards. This helps maintain code quality and readability across the project.

```Shell
npm run lint
```

--------------------------------

### Cleaning Compiled Output (Shell)

Source: https://github.com/starlingbank/starling-developer-sdk/blob/master/CONTRIBUTING.md

Runs a script to remove previously compiled or built files, typically from the distribution directory (e.g., 'dist'). This ensures a clean state before rebuilding the project.

```Shell
npm run clean
```

--------------------------------

### Automatically Fixing Linting Issues (Shell)

Source: https://github.com/starlingbank/starling-developer-sdk/blob/master/CONTRIBUTING.md

Executes the linter with auto-fix capabilities to automatically correct most code style and formatting issues detected. This is a quick way to resolve linting problems without manual intervention.

```Shell
npm run lint:fix
```
Tokens:
Raw