@anandchowdhary/node.ts

🏷️ Node.ts

Opinionated starter for server-side Node.js libraries, with TypeScript, tests with Jest, automated releases with GitHub Actions and Semantic Release, and coverage reporting from Travis CI to Coveralls.

⭐ Using Node.ts

Setting up repository

To get started, first generate your new repository. There are two ways to do this:

1. Generate a repository with Node.ts template is GitHub's preferred way
2. Import this repository keeps the commit history, which you may want

Updating README.md

Make the following changes to this README.md (note that these changes are case-sensitive):

1. Replace "Node.ts" with your project name
2. Replace "AnandChowdhary/node.ts" with your GitHub "username/repository"
3. Replace "@anandchowdhary/node.ts" with your npm package name
4. Replace "@anandchowdhary%2Fnode.ts" with your npm package name, URL-encoded

Updating package.json

Make the following changes to package.json:

1. Replace "@anandchowdhary/node.ts" with your npm package name
2. Change the version to "0.0.0" for Semantic Release to take over
3. Replace the description with your npm package description
4. Replace "AnandChowdhary/node.ts" with your GitHub "username/repository"
5. Replace "Anand Chowdhary [e-mail]" with you as the author
6. Replace "anandchowdhary.github.io" with "username.github.io"

Last steps

1. Add your npm token (NPM_TOKEN) as a GitHub secret in your repository (more details)
2. Log in or sign up on Coveralls and add your repository
3. Remove this section ("Using Node.ts"), keeping the "Usage" section below
4. Replace "AnandChowdhary/eject-dependencies" with your GitHub "username/repository" in .releaserc.json
5. Set up GitHub Pages with master branch
6. Write commits messages using Gitmoji

💡 Usage

Install the package from npm:

npm install @anandchowdhary/node.ts

Import and use;

import { nodeTs } from "@anandchowdhary/node-ts";

nodeTs();

👩‍💻 Development

Build TypeScript:

npm run build

Run unit tests and view coverage:

npm run test-without-reporting

📄 License

MIT © Anand Chowdhary