📝 docs(readme.md): updated documents

committing all changes

Author: jebarpg

README.md

@@ -2,22 +2,25 @@
 
 ## How to use
 
-NOTE: It is best to have created a github organization to use this template. There are a few features which require it. Namely publishing of typedocs to github_pages and the dependabot security features for organizations. Start reading [Creating a new organization from scratch](https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch) to learn.
+NOTE: It is best to have created a github organization to use this template. There are a few features which require it. Namely the dependabot security features for organizations. Start reading [Creating a new organization from scratch](https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch) to learn.
 
 This is my recommended way to use this template repo. By doing this you'll be able to use the gitmoji commitizen adapter to add your initial commit message with a gitmoji icon which will later be used to create the changelog automatically.
 
-*If you don't care about using gitmoji on your initial commit then you can simply click the `Use this template` button and select `Create a new repository`. [Here are the instructions](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template) to use this GitHub Template. Otherwise continue reading.*
+*If you don't care about using gitmoji on your initial commit then you can simply click the `Use this template` button and select `Create a new repository`. [Here are the github template instructions](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template) to use this GitHub Template. Otherwise continue reading.*
 
 First create a new empty github repository **WITHOUT** a `README.md`, `LICENSE`, or `.gitignore` we will add these later. Adding an *'optional description'* is fine at this point.
 
-Then run the following commands in the directory you will be working in:
-
 ```bash
 mkdir {your_empty_repo_name}
-git clone https://github.com/jebarpg/nodejs-project.git {your_empty_repo_name}
+git clone https://github.com/jebarpg/template-nodejs-project.git {your_empty_repo_name}
 cd {your_empty_repo_name}
-rm -rf .git
+rm -rf .git package-lock.json docs/typedocs/* CHANGELOG.md
 git init
+```
+
+Then run the following command in the directory you will be working in:
+
+```bash
 git remote add origin https://github.com/{username}/{your_empty_repo_name}.git
 ```
 
@@ -34,6 +37,91 @@ or
 ./repo_management_files/issues.bat #(for Windows OS)
 ```
 
-To create all the issues needed to finish setting this repo up.
+To create all the issues needed to finish setting this repo up. Look at issue #1 to and follow the directions.
+
+
+
+
+
+
+
+-----------------------------------------------------
+PUT THIS INTO ISSUE #1
+
+In package.json file do the following:
+    - [ ] find and replace all occurances of `template-nodes-project` with your repo's name
+    - [ ] set version to 1.0.0
+    - [ ] remove and replace keywords with your projects keywords
+    - [ ] configure or remove the funding to your specifics
+    - [ ] set the license
+    - [ ] review the validate-branch-name->pattern to see if the branches are approriate for your project
+    - [ ] review the cz-gitmoji-adapter->scopes list to see if the enteries are approritate for your project
+    - [ ] change publishConfig->access to `public` or `restricted` (for private)
+
+```bash
+bun i
+bun cm
+```
+
+In build.yml do the following:
+
+```bash
+bun i
+bun cm
+```
+
+In depcheck.yml do the following:
+
+```bash
+bun i
+bun cm
+```
+
+In docs.yml do the following:
+
+```bash
+bun i
+bun cm
+```
+
+In lint.yml do the following:
+
+```bash
+bun i
+bun cm
+```
+
+In pr.yml do the following:
+
+```bash
+bun i
+bun cm
+```
+
+In release.yml do the following:
+
+```bash
+bun i
+bun cm
+```
+
+In test.yml do the following:
+
+```bash
+bun i
+bun cm
+```
+
+for the commit type select: ` init              🎉  Initial commit. `
+for the scope type select; [none]
+for the short description: initalizing repo configuration
+for the longer description: made all the initial changes to package.json to get the template up and running
+for BREAKING CHANGE: Press Enter to skip
+for issues closed: #1
+NOTE: if you haven't run the issue.sh you can press enter to skip the issues
+
+```bash
+git push --set-upstream origin main
+```
 
 Open up issue #1 on your `https://github.com/{username}/{your_empty_repo_name}/issues` and complete all the tasks.

package.json

@@ -83,7 +83,7 @@
     "dev:mac": "bun i && bun concurrently -k \"bun run hot-reload & open http://127.0.0.1:3000\" \"bun run dev:post\"",
     "dev:node": "bun i && bun run build && bun concurrently -k \"nodemon ./dist/server.js localhost 8080\" \"bun run live-reload\" \"bun run format:watch\" \"bun run test:watch:fast\"",
     "dev:post": "bun concurrently -k \"bun run live-reload\" \"bun run format:watch\" \"bun run test:watch:fast\"",
-    "dev:pre": "bun run upgrade:full && bun rebuild && bun run dep:update:all && echo \"YOU CAN ALSO RUN npm-check TO SEE ADDITIONAL DEPENDENCY UPDATES\" && npm i && bun run depcheck && bun run prune:mod && bun run license:summary && bun format && bun run security",
+    "dev:pre": "bun run upgrade:full && bun rebuild && bun run dep:update:all && echo \"YOU CAN ALSO RUN npm-check TO SEE ADDITIONAL DEPENDENCY UPDATES\" && npm i --legacy-peer-deps && bun run depcheck && bun run prune:mod && bun run license:summary && bun format && bun run security",
     "dev:win": "bun i && bun concurrently -k \"bun run hot-reload & start http://127.0.0.1:3000\" \"bun run dev:post\"",
     "dev:wsl": "bun i && bun concurrently -k \"bun run hot-reload & wslview http://127.0.0.1:3000\" \"bun run dev:post\"",
     "docs": "echo building typedocs && bunx typedoc --validation.notDocumented --plugin typedoc-plugin-coverage --plugin typedoc-plugin-extras --options typedoc.json",
@@ -145,83 +145,83 @@
         ".prettierignore",
         ".prettierrc.json",
         "license",
-        "readme-api.md",
         "readme.md",
-        "commit-template.hbs",
         "commitlint.config.ts",
+        "commit-template.hbs",
+        "readme-api.md",
         "default-template.hbs",
         "jest.config.json",
         "package.json",
-        "package-lock.json",
         "release.config.ts",
         "renovate.json",
-        "tsconfig.json",
+        "package-lock.json",
         "typedoc.json",
+        "tsconfig.json",
         ".vscode/settings.json",
         "public/.gitkeep",
         "repo_management_files/auditchecklist.md",
+        "repo_management_files/branchnamingconventions.md",
         "repo_management_files/cz-emoji-template-extract.js",
-        "repo_management_files/cz-emoji-type-extract.js",
         "repo_management_files/cz-type-extract.js",
-        "repo_management_files/directorystructuredocument.md",
-        "repo_management_files/extractfilescopes.js",
         "repo_management_files/errorswarningsresolutions.md",
+        "repo_management_files/extractfilescopes.js",
+        "repo_management_files/directorystructuredocument.md",
+        "repo_management_files/cz-emoji-type-extract.js",
         "repo_management_files/fileswithgitmojis.md",
-        "repo_management_files/branchnamingconventions.md",
+        "repo_management_files/genericcommitmessages.md",
         "repo_management_files/gitmojisemver-extract.js",
         "repo_management_files/initializationinfo.md",
-        "repo_management_files/genericcommitmessages.md",
+        "repo_management_files/issues.sh",
         "repo_management_files/labels.sh",
-        "repo_management_files/packagejsondocument.md",
         "repo_management_files/usefultipsandtricks.md",
-        "repo_management_files/issues.sh",
+        "repo_management_files/packagejsondocument.md",
         ".github/dependabot.yml",
         ".github/workflows/build.yml",
+        ".github/workflows/depcheck.yml",
         ".github/workflows/docs.yml",
         ".github/workflows/lint.yml",
         ".github/workflows/pr.yml",
         ".github/workflows/release.yml",
-        ".github/workflows/depcheck.yml",
         ".github/workflows/test.yml",
         ".husky/commit-msg",
         ".husky/pre-commit",
         ".husky/prepare-commit-msg",
         ".husky/_/.gitignore",
+        ".husky/_/applypatch-msg",
         ".husky/_/commit-msg",
         ".husky/_/h",
         ".husky/_/post-applypatch",
-        ".husky/_/applypatch-msg",
         ".husky/_/post-checkout",
-        ".husky/_/post-merge",
+        ".husky/_/post-commit",
         ".husky/_/post-rewrite",
         ".husky/_/pre-applypatch",
         ".husky/_/pre-auto-gc",
-        ".husky/_/post-commit",
-        ".husky/_/pre-rebase",
         ".husky/_/pre-commit",
-        ".husky/_/prepare-commit-msg",
+        ".husky/_/post-merge",
         ".husky/_/pre-push",
-        "src/app.ts",
-        "src/bin/.gitkeep",
-        "src/controllers/.gitkeep",
-        "src/middleware/.gitkeep",
-        "src/routes/.gitkeep",
-        "src/plugins/.gitkeep",
-        "src/configs/.gitkeep",
-        "src/models/.gitkeep",
-        "src/views/.gitkeep",
-        "src/utils/.gitkeep",
+        ".husky/_/pre-rebase",
+        ".husky/_/prepare-commit-msg",
         "test/app.test.ts",
         "test/.gitkeep",
-        "test/controllers/.gitkeep",
         "test/bin/.gitkeep",
-        "test/configs/.gitkeep",
         "test/middleware/.gitkeep",
-        "test/plugins/.gitkeep",
-        "test/views/.gitkeep",
+        "test/configs/.gitkeep",
+        "test/controllers/.gitkeep",
         "test/routes/.gitkeep",
+        "test/plugins/.gitkeep",
+        "test/utils/.gitkeep",
         "test/models/.gitkeep",
-        "test/utils/.gitkeep"
+        "test/views/.gitkeep",
+        "src/app.ts",
+        "src/bin/.gitkeep",
+        "src/controllers/.gitkeep",
+        "src/configs/.gitkeep",
+        "src/models/.gitkeep",
+        "src/middleware/.gitkeep",
+        "src/plugins/.gitkeep",
+        "src/utils/.gitkeep",
+        "src/routes/.gitkeep",
+        "src/views/.gitkeep"
       ],
       "questions": {
         "scope": "Specify a scope: "
@@ -290,7 +290,7 @@
     "@semantic-release/npm": {
       "cacache": {
         "tar": "7.4.0",
-        "glob": "^10.0.0"
+        "glob": "^11.0.0"
       }
     }
   }

repo_management_files/initializationInfo.md

@@ -4,6 +4,9 @@ This file explains what each piece of information asked for in the [initializati
 
 ## Required Information Descriptions
 
+### Accounts To Create
+
+### Project Specific Information Fields
 
 - Project Name
   - package.json "name": ""