generated from jsynowiec/node-typescript-boilerplate
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding dependency on @aws-sdk/client-appconfigdatas, cleaning up pack…
…age.json and README.
- Loading branch information
Showing
3 changed files
with
2,088 additions
and
133 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,113 +1,12 @@ | ||
# node-typescript-boilerplate | ||
# aws-appconfig-poller | ||
|
||
[![Sponsor][sponsor-badge]][sponsor] | ||
[![TypeScript version][ts-badge]][typescript-5-1] | ||
[![Node.js version][nodejs-badge]][nodejs] | ||
[![APLv2][license-badge]][license] | ||
[![Build Status - GitHub Actions][gha-badge]][gha-ci] | ||
|
||
👩🏻💻 Developer Ready: A comprehensive template. Works out of the box for most [Node.js][nodejs] projects. | ||
A wrapper around @aws-sdk/client-appconfigdata to provide background polling and caching. | ||
|
||
🏃🏽 Instant Value: All basic tools included and configured: | ||
|
||
- [TypeScript][typescript] [5.1][typescript-5-1] | ||
- [ESM][esm] | ||
- [ESLint][eslint] with some initial rules recommendation | ||
- [Jest][jest] for fast unit testing and code coverage | ||
- Type definitions for Node.js and Jest | ||
- [Prettier][prettier] to enforce consistent code style | ||
- NPM [scripts](#available-scripts) for common operations | ||
- [EditorConfig][editorconfig] for consistent coding style | ||
- Reproducible environments thanks to [Volta][volta] | ||
- Example configuration for [GitHub Actions][gh-actions] | ||
- Simple example of TypeScript code and unit test | ||
|
||
🤲 Free as in speech: available under the APLv2 license. | ||
|
||
## Getting Started | ||
|
||
This project is intended to be used with the latest Active LTS release of [Node.js][nodejs]. | ||
|
||
### Use as a repository template | ||
|
||
To start, just click the **[Use template][repo-template-action]** link (or the green button). Start adding your code in the `src` and unit tests in the `__tests__` directories. | ||
|
||
### Clone repository | ||
|
||
To clone the repository, use the following commands: | ||
|
||
```sh | ||
git clone https://github.com/jsynowiec/node-typescript-boilerplate | ||
cd node-typescript-boilerplate | ||
npm install | ||
``` | ||
|
||
### Download latest release | ||
|
||
Download and unzip the current **main** branch or one of the tags: | ||
|
||
```sh | ||
wget https://github.com/jsynowiec/node-typescript-boilerplate/archive/main.zip -O node-typescript-boilerplate.zip | ||
unzip node-typescript-boilerplate.zip && rm node-typescript-boilerplate.zip | ||
``` | ||
|
||
## Available Scripts | ||
|
||
- `clean` - remove coverage data, Jest cache and transpiled files, | ||
- `prebuild` - lint source files and tests before building, | ||
- `build` - transpile TypeScript to ES6, | ||
- `build:watch` - interactive watch mode to automatically transpile source files, | ||
- `lint` - lint source files and tests, | ||
- `prettier` - reformat files, | ||
- `test` - run tests, | ||
- `test:watch` - interactive watch mode to automatically re-run tests | ||
|
||
## Additional Information | ||
|
||
### Why include Volta | ||
|
||
[Volta][volta]’s toolchain always keeps track of where you are, it makes sure the tools you use always respect the settings of the project you’re working on. This means you don’t have to worry about changing the state of your installed software when switching between projects. For example, it's [used by engineers at LinkedIn][volta-tomdale] to standardize tools and have reproducible development environments. | ||
|
||
I recommend to [install][volta-getting-started] Volta and use it to manage your project's toolchain. | ||
|
||
### ES Modules | ||
|
||
This template uses native [ESM][esm]. Make sure to read [this][nodejs-esm], and [this][ts47-esm] first. | ||
|
||
If your project requires CommonJS, you will have to [convert to ESM][sindresorhus-esm]. | ||
|
||
Please do not open issues for questions regarding CommonJS or ESM on this repo. | ||
|
||
## Backers & Sponsors | ||
|
||
Support this project by becoming a [sponsor][sponsor]. | ||
|
||
## License | ||
|
||
Licensed under the APLv2. See the [LICENSE](https://github.com/jsynowiec/node-typescript-boilerplate/blob/main/LICENSE) file for details. | ||
|
||
[ts-badge]: https://img.shields.io/badge/TypeScript-5.1-blue.svg | ||
[nodejs-badge]: https://img.shields.io/badge/Node.js->=%2018.12-blue.svg | ||
[nodejs]: https://nodejs.org/dist/latest-v18.x/docs/api/ | ||
[gha-badge]: https://github.com/jsynowiec/node-typescript-boilerplate/actions/workflows/nodejs.yml/badge.svg | ||
[gha-ci]: https://github.com/jsynowiec/node-typescript-boilerplate/actions/workflows/nodejs.yml | ||
[typescript]: https://www.typescriptlang.org/ | ||
[typescript-5-1]: https://devblogs.microsoft.com/typescript/announcing-typescript-5-1/ | ||
[license-badge]: https://img.shields.io/badge/license-APLv2-blue.svg | ||
[license]: https://github.com/jsynowiec/node-typescript-boilerplate/blob/main/LICENSE | ||
[sponsor-badge]: https://img.shields.io/badge/♥-Sponsor-fc0fb5.svg | ||
[sponsor]: https://github.com/sponsors/jsynowiec | ||
[jest]: https://facebook.github.io/jest/ | ||
[eslint]: https://github.com/eslint/eslint | ||
[wiki-js-tests]: https://github.com/jsynowiec/node-typescript-boilerplate/wiki/Unit-tests-in-plain-JavaScript | ||
[prettier]: https://prettier.io | ||
[volta]: https://volta.sh | ||
[volta-getting-started]: https://docs.volta.sh/guide/getting-started | ||
[volta-tomdale]: https://twitter.com/tomdale/status/1162017336699838467?s=20 | ||
[gh-actions]: https://github.com/features/actions | ||
[repo-template-action]: https://github.com/jsynowiec/node-typescript-boilerplate/generate | ||
[esm]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules | ||
[sindresorhus-esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c | ||
[nodejs-esm]: https://nodejs.org/docs/latest-v16.x/api/esm.html | ||
[ts47-esm]: https://devblogs.microsoft.com/typescript/announcing-typescript-5-1/#esm-nodejs | ||
[editorconfig]: https://editorconfig.org | ||
Licensed under the APLv2. See the [LICENSE](https://github.com/tarehart/aws-appconfig-poller/blob/main/LICENSE) file for details. |
Oops, something went wrong.