Harlem

Getting Started

Gettng started with Harlem is easy. Just follow the steps below and you'll be up and running in no time.

Installation

Install @harlem/core and any plugins you wish to include (I recommend installing @harlem/plugin-devtools during development):

npm install @harlem/core
1

Or if you're using Yarn:

yarn add @harlem/core
1

Register Harlem

Register the Harlem plugin with your Vue app instance:

import App from './app.vue';
import Harlem from '@harlem/core';

createApp(App)
    .use(Harlem)
    .mount('#app');
1
2
3
4
5
6

Create a store

Create your store and write any getters/mutations:

import {
    createStore
} from '@harlem/core';

const STATE = {
    firstName: 'John',
    lastName: 'Smith'
};

const {
    state,
    getter,
    mutation,
    on
} = createStore('user', STATE);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

See Also

Create Store API Reference