ssv-au-core

Core components, utilities and services for Aurelia by Sketch7.

Quick links

Installation

Get library via npm

npm install @ssv/au-core --save

Setup Plugin

import { CoreConfig } from "@ssv/au-core";

const config: CoreConfig = {
    routeActive: { activeClass: "selected" }
};
// register plugin with aurelia + configure
aurelia.use.plugin("@ssv/au-core", config);

Features

Feature	Status	Docs	Issue
logger	Done	read me	-
location	Done		-
store	Done	read me	-
route mapper	Done	read me	-

Components

Components	Type	Status	Docs	Issue
route-href	Attribute	Done	read me	-
route-active	Attribute	Done	read me	-

Getting Started

Setup Machine for Development

Install/setup the following:

NodeJS v10+
Visual Studio Code or similar code editor
TypeScript 3.1+
Git + SourceTree, SmartGit or similar (optional)
Ensure to install global NPM modules using the following:

npm install -g git gulp yarn

Cloning Repo

Run git clone https://github.com/sketch7/ssv-au-core.git
Switch to develop branch

Project Setup

The following process need to be executed in order to get started.

npm install

Building the code

gulp build
// or
npm run build

In order to view all other tasks invoke gulp or check the gulp tasks directly.

Running the tests

gulp test
// or
npm test

Development utils

Trigger gulp watch

Handles compiling of changes.

gulp watch
// or
npm start

Running Continuous Tests

Spawns test runner and keep watching for changes.

gulp tdd
// or
npm run tdd

Preparation for Release

npm run prepare-release -- --bump major|minor|patch|prerelease (default: patch)

Check out the release workflow guide in order to guide you creating a release and publishing it.

sketch7/ssv-au-core