Skip to content

code-server-boilerplates/nodejs-starter

Repository files navigation

Boilerplate for Node.js-based projects

This deploy-code-server template uses the starter-pack GHCR image as its base image in developing this starter. Includes Prettier, Typescript support and even CLIs by Vercel.

Tools Included

  • Everything in starter-pack, plus:
    • Node.js 14.x LTS, through Node Version Manager
    • Latest versions of Yarn and npmjs
    • Railway CLI, Heroku CLI, Vercel CLI, you name it. (we need to add more of them)
    • Eslint and Prettier for linting and formatting (and some plugins for seeding this image, PRs are always welcome!)
    • Commitlint and Commitizen for commit message format enforcement, among other maintainer tools
    • Miscellaneous stuff like @vercel/ncc, @vercel/pkg and npkill

Checklist for new template maintainers

This checklist is based on our Kubernetes/Cloud-Native starter, so this might be not accurate if you use this repo for your next template.

  • Duplicate this repo or generate as new repo to get started. Don't forget to complete the post-repo creation/generation checklist to setup GH Actions, Docker Hub/RHQCR/GHCR logins and Mergify.
  • Change any references to this template with your own.
  • Customize the Dockerfile to include the tools needed. Feel free to switch between base images if needed (or even build your own).
  • In charts/Chart.yml, reset the version to 0.1.0 and change the chart name into your repo name (the one after owner-username-here/ part).
  • Tag your changes as v0.1.0 (with git tag -a -m "v0.1.0 - Initial version" -s, which requires to setup GPG signing) and publish new release using that tag (don't set it as an prerelease, or things might go brr).
  • Cheers! Now, register to the template registry and we'll add your chart into our charts repo + activate your quick deploy links soon.

Deploy

Deployment docs are avaiable at this document, including Deploy to Railway/Okteto Cloud badges and stuff.

License and Contributing

This repository's contents is licensed under the MIT License. By contributing to this repository, you agree to Developer's Certificate of Origin and The Pins Team Community Code of conduct.

To learn more how to contribute, please see this page.

About

Node.js starter, with Node.js LTS, npmjs and Yarn in Node Version Manager. Based on work-in-progress work at https://github.com/code-server-boilerplates/starter-pack-as-base-image.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published