Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sketch7/ssv-au-core
Core components, utilities and services for Aurelia by Sketch7
https://github.com/sketch7/ssv-au-core
aurelia core utility
Last synced: about 2 months ago
JSON representation
Core components, utilities and services for Aurelia by Sketch7
- Host: GitHub
- URL: https://github.com/sketch7/ssv-au-core
- Owner: sketch7
- License: mit
- Created: 2016-05-03T22:32:19.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-10-27T19:16:34.000Z (over 6 years ago)
- Last Synced: 2024-11-13T16:28:52.122Z (3 months ago)
- Topics: aurelia, core, utility
- Language: TypeScript
- Homepage:
- Size: 390 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
[projectUri]: https://github.com/sketch7/ssv-au-core
[projectGit]: https://github.com/sketch7/ssv-au-core.git
[changeLog]: ./CHANGELOG.md
[releaseWorkflowWiki]: ./docs/RELEASE-WORKFLOW.md
[npm]: https://www.npmjs.com
# ssv-au-core
[](https://circleci.com/gh/sketch7/ssv-au-core)
[](https://badge.fury.io/js/%40ssv%2Fau-core)
Core components, utilities and services for Aurelia by Sketch7.
**Quick links**
[Change logs][changeLog] | [Project Repository][projectUri]
## Installation
Get library via [npm]
```bash
npm install @ssv/au-core --save
```
### Setup Plugin
Register `au-core` plugin with optional global configuration.
```ts
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][logger] | - |
| location | Done | | - |
| store | Done | [read me][store] | - |
| route mapper | Done | [read me][routemapper] | - |
## Components
| Components | Type | Status | Docs | Issue |
|------------------|-------------------|-----------------|----------------------------|----------------|
| route-href | Attribute | Done | [read me][routehref] | - |
| route-active | Attribute | Done | [read me][routeactive] | - |
[logger]: ./src/logging/README.md
[store]: ./src/store/README.md
[routemapper]: ./src/routing/README.md
[routehref]: ./src/routing/route-href/README.md
[routeactive]: ./src/routing/route-active/README.md
## 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:
```bash
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.
```bash
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][releaseWorkflowWiki] in order to guide you creating a release and publishing it.