https://github.com/clever/template-node-library
A template for building a node.js library
https://github.com/clever/template-node-library
Last synced: 11 months ago
JSON representation
A template for building a node.js library
- Host: GitHub
- URL: https://github.com/clever/template-node-library
- Owner: Clever
- Created: 2017-03-02T18:44:51.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-03-10T19:55:29.000Z (over 1 year ago)
- Last Synced: 2025-05-24T18:45:43.906Z (about 1 year ago)
- Language: JavaScript
- Size: 39.1 KB
- Stars: 0
- Watchers: 47
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# {{.AppName}}
{{.Description}}
Owned by {{.TeamName}}
## Developing
- Update package.json with your library name (`@clever/` if private)
- `npm install`
- Write the library in the `lib/` folder
- Write tests in files suffixed with `.test.ts[x]`
### TypeScript Target
We default the TypeScript compilation target to ES5 for compatibility with older browsers (IE, older versions of Safari).
If your library is intended for use in server code rather than client code, feel free to increase the target in the tsconfig.json. Using a higher target can increase compilation speed and decrease compiled code size.
Independent of the target that you specify, you can still use the latest JavaScript features in your source code, as we specify the latest JavaScript in the tsconfig.json lib setting.
## Testing
```
make test
```
## Building for local use
```
# This will compile lib/ to JavaScript in the dist/ folder
make build
```