@fdnd/components

Components

Frontend Design & Development (FDND) is an Associate Degree programme at the Amsterdam University of Applied Sciences (AUAS). For our microsites we use the components as defined in this NPM package. This project is intended for internal use but as we strive to be an open source (GPLv3) Higher Ed. programme we intend to share everything that is not GDPR sensitive.

Description

It's a component library for FDND students and teachers. It implements the FDND styleguide and is actively maintained as it's components are used throughout our microsite environment.

Table of Contents

• Description
• Installation
• Use
• Contribute
• Publishing

Installation

Install this dependency with NPM or your prefered package manager.

npm install @fdnd/components

Include only the components you want to use. A visual overview of the available components is not available (yet), but you can find a textual overview here.

Use

<script>
  import { Header, PageHeader } from '@fdnd/components';
  const pageHeaderContents = {
    subtitle: 'Associate Degree',
    title: 'Frontend design & development',
    meta: [
      {
        label: 'Duur',
        text: 'Twee jaar'
      },
      {
        label: 'Type',
        text: 'Voltijd'
      },
      {
        label: 'Open dag',
        text: '4 november 2022'
      }
    ]
  };
</script>

<Header title="FDND Programma" />
<PageHeader content={pageHeaderContents} />

Contribute

Clone this repository using git clone and create a test SvelteKit project (if you haven't already).

Run npm run install and npm run package

Use npm link ../path-to/components/package in your test project folder to create a local link. See more on linking local packages with NPM.

Now when you update anything in the local package, run npm run package and your test project will be able to reach it. Changes will be automagically picked up if you have a running npm run dev process on your test project.

Publishing

Bump the version of the package using npm version patch -m "Upgrade to %s; descriptive message plx". Without a version bump, it's not possible to publish the new version of the package. This is a restriction forced by NPM.

Run npm publish, you might be asked to login to the NPM registry, just follow the instructions. If you're not added as a user to the @FDND organisation on NPM (this is not the same as the FDND organisation on Github), you are not able to publish this package. Ask @ju5tu5 for access :)

License

This work is licensed under GNU GPLv3.