README
This commit is contained in:
parent
fbdeba9eed
commit
05ae7fb9db
164
README.md
164
README.md
@ -1,113 +1,93 @@
|
|||||||
# node-typescript-boilerplate
|
# webapp-deployment-status-api
|
||||||
|
|
||||||
[![Sponsor][sponsor-badge]][sponsor]
|
This API provides status information about webapp deployment requests and a mechanism for upload encrypted configuration
|
||||||
[![TypeScript version][ts-badge]][typescript-5-3]
|
files used by those requests.
|
||||||
[![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.
|
## Build and Run
|
||||||
|
|
||||||
🏃🏽 Instant Value: All basic tools included and configured:
|
```
|
||||||
|
$ yarn
|
||||||
- [TypeScript][typescript] [5.3][typescript-5-3]
|
$ yarn build
|
||||||
- [ESM][esm]
|
$ yarn start
|
||||||
- [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
|
## Configuration
|
||||||
|
|
||||||
Download and unzip the current **main** branch or one of the tags:
|
### Keys
|
||||||
|
|
||||||
```sh
|
Configuration files are encrypted prior to being uploaded using an RSA `publicKey` specified in the `WebappDeployer` record.
|
||||||
wget https://github.com/jsynowiec/node-typescript-boilerplate/archive/main.zip -O node-typescript-boilerplate.zip
|
On upload, the configuration is temporarily decrypted for validation, but stored in its encrypted format.
|
||||||
unzip node-typescript-boilerplate.zip && rm node-typescript-boilerplate.zip
|
|
||||||
|
To create and export a key in the necessary format use:
|
||||||
|
|
||||||
|
```
|
||||||
|
# Create a key
|
||||||
|
$ gpg --batch --passphrase "SECRET" --quick-generate-key webapp-deployer-api.my.domain.com default default never
|
||||||
|
|
||||||
|
# Export the public key
|
||||||
|
$ gpg --export webapp-deployer-api.my.domain.com > webapp-deployer-api.my.domain.com.pgp.pub
|
||||||
|
|
||||||
|
# Export the private key
|
||||||
|
$ gpg --export-secret-keys webapp-deployer-api.my.domain.com > webapp-deployer-api.my.domain.com.pgp.key
|
||||||
```
|
```
|
||||||
|
|
||||||
## Available Scripts
|
### Create the Deployer Record
|
||||||
|
|
||||||
- `clean` - remove coverage data, Jest cache and transpiled files,
|
Every webapp deployer should have `WebappDeployer` record in the registry which looks something like:
|
||||||
- `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
|
```
|
||||||
|
record:
|
||||||
|
type: WebappDeployer
|
||||||
|
version: 1.0.0
|
||||||
|
name: webapp-deployer-api.my.domain.com
|
||||||
|
apiUrl: https://webapp-deployer-api.my.domain.com
|
||||||
|
minimumPayment: 100alnt
|
||||||
|
paymentAddress: laconic1clpc8smrhx5k25zmk3vwna8kddxrsem7a1jlry
|
||||||
|
publicKey: mQGNBGbJUk0BDAC3j3CiaVtoEf1jrgtsjJnTA5u1a3BExP72mv0eE8y84TgY5rVcf ...
|
||||||
|
```
|
||||||
|
|
||||||
### Why include Volta
|
This record can most easily be created using `laconic-so publish-deployer-to-registry`.
|
||||||
|
|
||||||
[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.
|
```
|
||||||
|
$ laconic-so publish-deployer-to-registry \
|
||||||
|
--laconic-config ~/.laconic/registry.yml \
|
||||||
|
--api-url https://webapp-deployer-api.my.domain.com
|
||||||
|
--public-key-file webapp-deployer-api.my.domain.com.pgp.pub \
|
||||||
|
--lrn lrn://laconic/deployers/webapp-deployer-api.my.domain.com \
|
||||||
|
--min-required-payment 100
|
||||||
|
```
|
||||||
|
|
||||||
I recommend to [install][volta-getting-started] Volta and use it to manage your project's toolchain.
|
This will create the record in the proper format and assign its LRN.
|
||||||
|
|
||||||
### ES Modules
|
### Request Deployment
|
||||||
|
|
||||||
This template uses native [ESM][esm]. Make sure to read [this][nodejs-esm], and [this][ts47-esm] first.
|
Users can now request deployment using the LRN of the deployer. This will allow them to:
|
||||||
|
|
||||||
If your project requires CommonJS, you will have to [convert to ESM][sindresorhus-esm].
|
1. Discover the API URL for config uploads.
|
||||||
|
1. Obtain the public key for encrypting config.
|
||||||
|
1. See the minimum required payment.
|
||||||
|
|
||||||
Please do not open issues for questions regarding CommonJS or ESM on this repo.
|
The request can be made using `laconic-so request-webapp-deployment`. This will handle encrypting and uploading the
|
||||||
|
config automatically, as well as making a payment (if necessary).
|
||||||
|
|
||||||
## Backers & Sponsors
|
```
|
||||||
|
$ laconic-so request-webapp-deployment \
|
||||||
|
--laconic-config ~/.laconic/registry.yml \
|
||||||
|
--deployer lrn://laconic/deployers/webapp-deployer-api.my.domain.com \
|
||||||
|
--app lrn://cerc-io/applications/webapp-hello-world@0.1.3 \
|
||||||
|
--env-file hello.env \
|
||||||
|
--make-payment auto
|
||||||
|
```
|
||||||
|
|
||||||
Support this project by becoming a [sponsor][sponsor].
|
### Example Config
|
||||||
|
|
||||||
## License
|
```
|
||||||
|
UPLOAD_DIRECTORY="/srv/uploads/config"
|
||||||
Licensed under the APLv2. See the [LICENSE](https://github.com/jsynowiec/node-typescript-boilerplate/blob/main/LICENSE) file for details.
|
UPLOAD_MAX_SIZE="1MB"
|
||||||
|
DEPLOYER_STATE="/srv/deployments/autodeploy.state"
|
||||||
[ts-badge]: https://img.shields.io/badge/TypeScript-5.3-blue.svg
|
UNDEPLOYER_STATE="/srv/deployments/autoundeploy.state"
|
||||||
[nodejs-badge]: https://img.shields.io/badge/Node.js->=%2020.9-blue.svg
|
BUILD_LOGS="/srv/logs"
|
||||||
[nodejs]: https://nodejs.org/dist/latest-v20.x/docs/api/
|
OPENPGP_PASSPHRASE="SECRET"
|
||||||
[gha-badge]: https://github.com/jsynowiec/node-typescript-boilerplate/actions/workflows/nodejs.yml/badge.svg
|
OPENPGP_PRIVATE_KEY_FILE="/etc/config/webapp-deployer-api.my.domain.com.pgp.key"
|
||||||
[gha-ci]: https://github.com/jsynowiec/node-typescript-boilerplate/actions/workflows/nodejs.yml
|
LACONIC_CONFIG="/etc/config/registry.yml"
|
||||||
[typescript]: https://www.typescriptlang.org/
|
```
|
||||||
[typescript-5-3]: https://devblogs.microsoft.com/typescript/announcing-typescript-5-3/
|
|
||||||
[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
|
|
||||||
[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-4-7/#esm-nodejs
|
|
||||||
[editorconfig]: https://editorconfig.org
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user