tscoverage/docs/structure.md

27 lines
896 B
Markdown
Raw Permalink Normal View History

2017-09-05 16:48:12 +00:00
---
name: npmts project structure
description: how npmts projects are structured
---
2017-09-06 13:52:46 +00:00
# npmts - Project Structure
**locally**
```text
projectroot
|- .nogit/ # contains files that should not be checked into git - NOgit
|- dist/ # contains compiled js files and their corresponding typings - git
|- node_modules/ # contains the installed node modules - NOgit
|- test/ # contains the test files - git
|- ts/ # contains the source TypeScript files - git
|
|- .gitignore # the normal gitignore file
|- .gitlab-ci.yml # the gitlab ci yml file
|- npmextra.json # npmextra.json
2017-09-06 13:59:27 +00:00
|- package.json # the standard npm module package.json file
|- readme.md # the standard project readme
|- tslint.json # the standard tslint.json for TypeScript
|- yarn.lock # yarn.lock - the standard yarn.lock file
2017-09-06 13:52:46 +00:00
```
**in git**