Skip to content

Latest commit

 

History

History
32 lines (22 loc) · 1.35 KB

DEVELOPER_GUIDE.md

File metadata and controls

32 lines (22 loc) · 1.35 KB

Developer Guide for the Platform

Source Structure

The source has two parts, the platform and a documentation app.

/src/app - Contains the documentation application
/src/platform - Contains the platform assets

Adding a new platform component

Add a new directory based on the name to src/platform/[name] and it should contain a folder structure that has the following:

  • index.ts - exports values
  • [name].component.ts - component source
  • [name].component.html - component markup
  • [name].component.css - component css (change extention to scss manually, we want scss files to compile)
  • [name].component.spec.ts - component unit test
  • package.json - configurations used for npm to publish it (name[@covalent/name], version, dependencies, etc)
  • README.md - readme file with documentation for github and npm registry.

Then you will need to add a path src/system-config.ts under the library barrels that points to your new component directory, such as 'platform/[name]',.

Adding a new documentation component

You can use the ng generate component components/[name] and it will generate the new component stub in src/app/components/[name].