customization.md

Customization

Customize this app to make it your own

Things to do once you've created a new project from this one:

• Update title and description of the docs.
• Add/update badges.
• Update package.json with scripts and dependencies.
• Develop your core app.
• Choose a test framework (Jest, Jasmine, Enzyme, Mocha...) and write tests with it. Bonus points if you write tests before your app for true TDD!
• Customize lint config:
  • Edit the exiting .eslintrc.js config.
  • Or create a new one:

    rm .eslintrc.js
    npx eslint --init

  • Or add an eslintConfig field to package.json.
• Update ignore file.
  • If you use Yarn, take out npm-debug.log* and add:

    yarn-debug.log*
    yarn-error.log*
    

• Add other build tools like Prettier, Husky, Webpack, Vite, or Babel.
• Customize your build flow:
  • For now JS scripts are just copied to build but you might use dist or out instead.
  • You might use TypeScript or Babel to handle this for you and then split out build and compile steps.
  • Or maybe you have no build command and so this can beremoved from package.json.
• Update docs such as usage instructions and add sample image to Preview section.
• Optional - setup the docs directory to server as a Docsify docs site, then enable as GitHub Pages site. See my Docsify quickstart instructions
• Update license file details if needed (change type and put on your own name).
• Customize CI/CD flow.
  • See Deploy doc for how this currently works.
  • If you need a more advanced workflow for GitHub Actions, see Node workflow samples.
• Add credits
  • Add a link back to the original repo in - https://github.com/MichaelCurrin/node-project-template
  • Copy the original license and then put your own name in LICENSE file.

    $ cp LICENSE LICENSE-source
    $ edit LICENSE

• Delete unneeded sections in README.md doc.
• Delete the template-notes directory in docs/.
• Containerize your app. See Docker Node app quickstart