![]() ![]() Perform all development workflow steps including pushing to GitHub in order to verify the CI builds.Again, success depends upon the awesomeness of your code.įollow these steps to update your NPM package: Push to GitHub using git push and wait for the CI builds to complete.Commit your changes using git add and git cz.Verify code coverage: npm run cover:check.If your code is not awesome, you may have to fix some things here. Create unit tests in the test directory.Build (clean, lint, and transpile): npm run build.Write awesome code in the src directory.These steps need to be performed whenever you make changes: Publish your package to NPMJS: npm publish.Check the "Actions" tab on the GitHub repo and wait for the Node.js CI build to complete.Coveralls for unit test coverage verification.GitHub Actions for continuous integration.The project is preconfigured, so it should "just work" with these tools. Create accounts on the following sites and add your new GitHub project to them.Create your project on GitHub (do not add a README.Some additional steps need to be performed for a new project. Update this README.md file to describe your project.īefore committing to a project based on this template, it's recommended that you read about Conventional Commits and install Commitizen CLI globally.If you prefer something other than the BSD 3-Clause License, replace the entire contents of LICENSE as appropriate. ![]() In the author section, add email if you want to include yours.Change description to suit your project.Replace my NPM project name with yours: typescript-template.Replace my GitHub username and project name with yours: chriswells0/node-typescript-template.Replace my name with yours: Chris Wells.Use exact searches to perform the following replacements throughout this project for the most efficient rebranding process: Thus, the order of these replacements matter.īe sure to check both GitHub and NPMJS to verify that your project name isn't taken before starting! It's a common practice to prefix the source code project name with node- to make it clear on GitHub that it's a Node.js project while omitting that prefix in the NPM project since it's understood on. ContentsĬlone this repo into the directory you want to use for your new project, delete the Git history, and then reinit as a fresh Git repo: This project template even enables automated changelog generation as long as you follow Conventional Commits, which is made simple through the included Commitizen CLI. Once you've enabled CI, test coverage, and dependency reports for your project, this README.md file shows how to add the badges shown above. Managing ignored files for Git and NPM.Creating an NPM package for your project.Setting up unit tests and code coverage reports.Adding and configuring TypeScript support.It allows you to skip the tedious details for the following: A complete Node.js project template using TypeScript and following general best practices. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |