A Git template for bootstrapping a variety of projects with a consistent set of control files.
Template Instructions
- Create your new repository by clicking the "Use this template" button from the GitHub repository. (or download from https://github.com/tforster/git-new/archive/master.zip and unzip)
- Follow the GitHub prompts to complete the configuration of your new repository
- Clone your new repository to your local develop environment
- Install NPM dependencies including linters and code prettiers
npm i - Edit README.md
- Edit the title to match your project
- Edit the description to describe your project
- Edit Prerequisites, Setup and Configuration, Usage, For Users and Meta sections
- Edit package.json
- Update the title to match the title of this README
- Update the description to match the description of this README
- Edit the semantic version to match your project requirements
- Update your LICENSE
- Edit the year and fullname variables in LICENSE.txt
- The provided LICENSE file implements the MIT license as per https://choosealicense.com/licenses/mit
- For closed source delete the LICENSE.txt file and update the package.json license property to "UNLICENSED"
- If neither MIT or UNLICENSED suit your needs consider creating a LICENSE.txt from https://choosealicense.com/
- Update CODE_OF_CONDUCT.md. For more information on code of conduct see https://opensource.guide/code-of-conduct/
- Update CONTRIBUTING.md. For more information about open source contributions see https://help.github.com/en/github/building-a-strong-community/setting-guidelines-for-repository-contributors
- Delete any unwanted/unused files or folders such as
/docker,/webproducer, etc. - Update CHANGELOG.md
- Delete this instruction block
The versions listed for these prerequisites are current at the time of writing. More recent versions will likely work but "your mileage may vary".
- A good code editor.
- Node.js v12.13.0 and NPM 7.0.0
- Git 2.28
-
Clone to repository locally, following the directory structure convention:
git clone [email protected]:tforster/git-new.git \ ~/dev/{agent}/{client}/{product}/{project}/{component}
-
Change the current working directory to the new repository directory:
cd ~/dev/{agent}/{client}/{product}/{project}/{component}
-
Install dependencies:
npm install
Environment files are .gitignored by default since they typically contain sensitive information. This section describes how to manually create an environment file for this project. Note that the .env file is located in the webproducer folder.
# Comment describing the variable
VARIABLE=some-valueDescribe the usage here.
To contribute to this project, please see CONTRIBUTING.md.
To view the release notes for all available versions, please see CHANGELOG.md.