@windward/core

0.8.0 • Public • Published

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'

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

    eg:

    import UserFileAsset from './models/UserFileAsset'
    
  2. For files in the windward-core repository use ~/

    eg:

    import ContentBlockAsset from '~/components/Content/ContentBlockAsset.vue'
    import BaseContentBlock from '~/components/Content/Blocks/BaseContentBlock'
    
  3. 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'
    
  4. 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,
    }

Code of Conduct

In order to ensure that the Windward community is welcoming to all we follow the same code of conduct as Laravel.

Security Vulnerabilities

If you discover a security vulnerability within Windward, please create a ticket on this repository and tag it as "security"

License

Windward LMS is open-sourced software licensed under the MIT license.

Readme

Keywords

none

Package Sidebar

Install

npm i @windward/core

Weekly Downloads

0

Version

0.8.0

License

MIT

Unpacked Size

869 kB

Total Files

286

Last publish

Collaborators

  • christinapassafaro
  • dschraderme
  • tcelestin
  • jrogaishio
  • mind-edge