@windward/core NPM

Windward UI Plugin Library

Windward UI plugin library implements content components add amplify windward's ability to simplify editor's workflow

Getting Started Locally with npm

Software Requirements:

Node v16+, npm v8+

Clone the windward-ui-plugin-core repository

$ cd windward-ui-plugin-core
$ npm install
$ npm link

Clone the windward-ui repository and follow README to setup

Link to Windward ui repo

$ cd windward-ui
$ npm install
$ cd node_modules
$ npm link @windward/core
$ npm run dev

Your Repos are linked at this point and you are ready to start developing windward plugins

Code Styles

`import x from 'path'`

For files in this repository use ./ or ../

eg:

import UserFileAsset from './models/UserFileAsset'

For files in the windward-core repository use ~/

eg:

import ContentBlockAsset from '~/components/Content/ContentBlockAsset.vue'
import BaseContentBlock from '~/components/Content/Blocks/BaseContentBlock'

When unit testing only and for files in this repository use ./ or ../ or @/
For ease of use the @/ alias is available to navigate to the root of this project. The @/ alias is synonymous to the ~/ however it's bound to THIS repository instead of the windward-core repository.
eg:
```
import UserUpload from '@/components/Content/Blocks/UserUpload.vue'
```

To add a page use the below format in your pages: [] in plugin.js

{
    // The name to be used by the vue router. This must be unique
    name: 'PluginUserUploadPage',
    // The vue router path. Use :course to allow the page to be accessed while in a course
    path: '/course/:course/user-uploads',
    // The template to use for the page
    template: UserUploadPage,
}