Git Product home page Git Product logo

jebarpg / template-nodejs-project Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 2 KB

Template starter project with eslint, prettier, esdoc, typedocs, swagger, gitmoji [commitizen, commitlint, conventional changelog, semantic-release], readme badges, dependabot, renovate, snyk, codecove.io, GitHub actions CI/CD, standard GitHub markdown files.

License: MIT License

airbnb badge-generator commitizen commitlint conventional-changelog eslint gitmoji husky jest live-server prettier renovate semantic-release shieldio snyk swagger typedocs esdocs issue-templates workflows

template-nodejs-project's Introduction

template-nodes-project

Template starter project with eslint, prettier, esdoc, typedocs, swagger, gitmoji [commitizen, commitlint, conventional changelog, semantic-release], readme badges, dependabot, renovate, snyk, codecove.io, GitHub actions CI/CD, standard GitHub markdown files.

template-nodejs-project's People

Contributors

jebarpg avatar

Watchers

 avatar

template-nodejs-project's Issues

Configure .gitignore

You may want to uncomment the following lines to include them in your repository\n- [ ] 'lines 23:#coverage'\n- [ ] 'lines 92:#dist'

Configure package.json

package.json Configurations

  • Change name to {your_project_name}
  • Add description
  • Add main entry point e.g. index.js or index.ts
  • Change keywords to suit your project
  • Change license to suit your project
  • Change author to the correct author name

Configure cz-gitmoji-adapter

In addition to the following sections you may follow this configuration guide cz-gitmoji-adapter
Configuration Options

  • Add/Remove 'scopes' appropriate for your project inside config->cz-gitmoji-adapter->scopes array
  • Change questions texts inside config->cz-gitmoji-adapter->questions array
    OPTIONS are scope, body, issues, breaking, type and subject

  • Change repository URL to your project URL
  • Change bugs->url to your project's URL
  • Change homepage->url to your project's homepage URL
  • Set appropriate publishConfig->access of the repo
    OPTIONS are public for public repos and restricted for private repos.
  • Evaluate additonal fields to be added to your package.json file as needed by reading Configuring package.json

Configure package.json

package.json Configurations

  • Change name: command not found to {your_project_name}
  • Add description
  • Add main: command not found entry point e.g. index.js or index.ts
  • Change keywords: command not found to suit your project
  • Change 'license' to suit your project
  • Change author

Configure cz-gitmoji-adapter

In addition to the following sections you may follow this configuration guide cz-gitmoji-adapter
Configuration Options

  • Add/Remove 'scopes' appropriate for your project
  • Change questions: command not found texts
    Options are scope: command not found, body: command not found, issues: command not found, breaking: command not found, and subject: command not found
  • Change repository: command not found URL to your project URL
  • Change bugs: command not found URL to your project URL
  • Change homepage: command not found URL to your projects homepage URL
  • Set appropriate publishConfig: command not found access of the repo
    Options are public: command not found for public repos and restricted: command not found for private repos.

Configure .gitignore

You may want to uncomment the following lines to include them in your repository
- [ ] 'lines 23:#coverage'
- [ ] 'lines 92:#dist'

Configure package.json and set your environment variables

package.json Configurations

  • Change name to {your_project_name}
  • Add description
  • Add main entry point e.g. index.js or index.ts
  • Change keywords to suit your project
  • Change license to suit your project
  • Change author to the correct author name

Configure cz-gitmoji-adapter

In addition to the following sections you may follow this configuration guide cz-gitmoji-adapter
Configuration Options

  • Add/Remove 'scopes' appropriate for your project inside config->cz-gitmoji-adapter->scopes array
  • Change questions texts inside config->cz-gitmoji-adapter->questions array
    OPTIONS are scope, body, issues, breaking, type and subject

  • Change repository URL to your project URL
  • Change bugs->url to your project's URL
  • Change homepage->url to your project's homepage URL
  • Set appropriate publishConfig->access of the repo
    OPTIONS are public for public repos and restricted for private repos
  • Evaluate additonal fields to be added to your package.json file as needed by reading Configuring package.json

Set your environment variables

  • Follow these instructions to set your export GH_TOKEN={your_github_PAT} environment variables for your given OS
  • (Optional) If you are using a GPG key to sign your commits (highly recommended) then also set the following variables as well.
    export GIT_AUTHOR_NAME={your_gpg_author_name}; export GIT_AUTHOR_EMAIL={your_gpg_email_address}; export GIT_COMMITTER_NAME={your_gpg_author_name}; export GIT_COMMITTER_EMAIL={your_gpg_email_address}
    These will allow for semantic release to work by running the commandline script npm run release outside of a CI environment
    and also allow you to push commits to your new repo without having to enter your username and PAT every time.

Use the npm cm to close this issue once you have completed all the tasks above.

Configure package.json

##Configurations to make

  • Change name: command not found to {your_project_name}
  • Add description: command not found
  • Add main: command not found entry point e.g. index.js or index.ts
  • Change keywords: command not found to suit your project
  • Change 'license' to suit your project
  • Change author

Configure cz-gitmoji-adapter

In addition to the following sections you may follow this configuration guide cz-gitmoji-adapter
Configuration Options

  • Add/Remove 'scopes' appropriate for your project
  • Change questions: command not found texts
    Options are scope: command not found, body: command not found, issues: command not found, breaking: command not found, and subject: command not found
  • Change repository: command not found URL to your project URL
  • Change bugs: command not found URL to your project URL
  • Change homepage: command not found URL to your projects homepage URL
  • Set appropriate publishConfig: command not found access of the repo
    Options are public: command not found for public repos and restricted: command not found for private repos.

Configure package.json

package.json Configurations

  • Change name to {your_project_name}
  • Add description
  • Add main entry point e.g. index.js or index.ts
  • Change keywords to suit your project
  • Change license to suit your project
  • Change author

Configure cz-gitmoji-adapter

In addition to the following sections you may follow this configuration guide cz-gitmoji-adapter
Configuration Options

  • Add/Remove 'scopes' appropriate for your project inside config->cz-gitmoji-adapter->scopes array
  • Change questions texts inside config->cz-gitmoji-adapter->questions array
    OPTIONS are scope, body, issues, breaking, type and subject

  • Change repository URL to your project URL
  • Change bugs->url to your project's URL
  • Change homepage->url to your project's homepage URL
  • Set appropriate publishConfig->access of the repo
    OPTIONS are public for public repos and restricted for private repos.

Configure .gitignore

You may want to uncomment the following lines to include them in your repository

  • 'lines 23:#coverage'
  • 'lines 92:#dist'

Configure package.json

package.json Configurations

  • Change name to {your_project_name}
  • Add description
  • Add main entry point e.g. index.js or index.ts
  • Change keywords to suit your project
  • Change 'license' to suit your project
  • Change author

Configure cz-gitmoji-adapter

In addition to the following sections you may follow this configuration guide cz-gitmoji-adapter
Configuration Options

  • Add/Remove 'scopes' appropriate for your project inside config->cz-gitmoji-adapter->scopes array
  • Change questions texts inside config->cz-gitmoji-adapter->questions array
    Options are scope, body, issues, breaking, type and subject
  • Change repository URL to your project URL
  • Change bugs URL to your project URL
  • Change homepage URL to your projects homepage URL
  • Set appropriate publishConfig access of the repo
    Options are public for public repos and restricted for private repos.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.