AckeeCZ / package-template

This is template for OSS back-end projects

DEPRECATION NOTICE

This package is no longer maintained.

Package template

This is template for OSS back-end projects

Local setup

History

• Delete .git folder, git init and create root commit

Project files

CHANGELOG

• reset history

package.json

• update author & contributors
• update name & description
• update repository, version

typedoc.json

• update name

LICENSE

• update year / owner

README

• update title, description
• update / remove badges
• update license if changed

Remote services

npm

deploy:
  provider: npm
  # TODO
  email: [e-mail]
  skip_cleanup: true
  # TODO
  api_key:
    secure: G8gmvUC5aRLRicRx...=
  on:
    tags: true
    repo: AckeeCZ/package-template

To generate npm api key:

1. Visit tokens and create new one with publish permissions
2. travis login --com
3. travis encrypt --com TOKEN

Travis

• Check .travis.yml (see node_js for versions of node, and script for the task definition)
• Log in to Travis
• Add the project (wait for permission asking as member of organization)
• Update script, deploy (add npm, remove GH pages or update API key etc.)

Codeclimate, Snyk, David, CodeClimate

• No need to integrate, just update links

License

This project is licensed under MIT.