0.8.0 • Published 7 years ago
carbonldp-panel v0.8.0
carbonldp-panel
Common components, services and utilities shared between different panel projects
Development
Setup
- Install dependencies:
- node.js
- gulp:
npm install gulp -g
cd
into the project's root folder- Run
npm install
File Structure
.
├── dist # Package's source files ready to be packaged or published
├── src # Source files (directives, componentes, services and modules)
├── typings # Typescript description files
│ ├── customs # Directory to store custom description files
│ │ ├── codemirror
│ │ │ └── index.d.ts # Codemirror's description file
│ │ ├── highlightjs
│ │ │ └── index.d.ts # HighlightJS's description file
│ │ ├── jstree
│ │ │ └── index.d.ts # JSTree's description file
│ │ └── semantic-ui
│ │ └── index.d.ts # Semantic-UI's description file
│ └── typings.d.ts # Main typings file referencing all index.d.ts custom files
├── .gitignore # Ignore file for git
├── .gitmodules # Submodules file for git
├── .travis.yml # Travis configuration file
├── CHANGELOG # File to track package changes
├── gulpfile.js # Gulp's configuration file
├── LICENSE
├── package.json # npm configuration file
├── README.md # this
└── tsconfig.json # Typescript compiler configuration file
Gulp Tasks
build
: Builds the dist version of the projectbuild:prepare-npm-package
: Prepares publishable npm package inside of thedist
directorybuild:prepare-npm-package:copy:docs
: Copies documentation files for the publishable npm packagebuild:prepare-npm-package:copy:package-json
: Copies and prepares thepackage.json
file for the publishable npm packageclean:dist
: Cleans thedist
directoryclean:compiled
: Cleans thecompiled
directorycopy:styles
: Copies style files (scss) and copies them into thedist
directorycopy:templates
: Copies template files (html) to thedist
directorycopy:typescript
: Copies typescript files (ts) to thedist
directorycompile
: Runsclean:compiled
and thencompile:typescript
compile:typescript
: Compiles typescript files (ts) into thecompiled
directorywatch
: Sets up a service to watch for any change to any source file and run the associated tasks to them. Really useful for developmentwatch:styles
: Watches for changes in style files (sass/scss)watch:templates
: Watches for changes in template files (html)watch:typescript
: Watches for changes in typescript files (ts)
Publishing the project
TODO
TODO
- Linting
- Testing
LICENSE
Copyright (c) 2015-present, Base22 Technology Group, LLC.
All rights reserved.
This source code is licensed under the BSD-style license found in the
LICENSE file in the root directory of this source tree.