Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xkeshav/template
A template repository
https://github.com/xkeshav/template
health-files template-repository
Last synced: about 2 months ago
JSON representation
A template repository
- Host: GitHub
- URL: https://github.com/xkeshav/template
- Owner: xkeshav
- License: mit
- Created: 2024-02-14T03:18:05.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-08-28T04:21:37.000Z (4 months ago)
- Last Synced: 2024-08-28T05:33:03.981Z (4 months ago)
- Topics: health-files, template-repository
- Language: JavaScript
- Homepage: https://xkeshav.github.io/template/
- Size: 346 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
- Support: .github/SUPPORT.md
Awesome Lists containing this project
README
# Template Repository
![Template][template]
![License][license]
![Open Issues][issues]
![Commit Count][commits]
![Total Pull Request][PR]
This is a template repository which contains
- community health files under mostly under `.github`
- _package.json_ boilerplate
- github action under `.github/workflows` for markdown file validity
- `.vscode` folder which have
- code snippets
- user / workspace settings file
- recommended extensions
- project dictionaries
## Pre-requisite
- Node 18+
- VS Code IDE
## How to use this Template repository
- Open this [repository][repo] in GitHub
- Click on `use this template` tab; near _star_ tab
- Make necessary changes in
- _package.json_
- replace _template_ with your project name.
- markdown files under _.github_ folder
- change contact email address and url wherever required.
## Folder Tree
Repository Folder Structure
```txt
├── .editorconfig
├── .github
│ ├── CODEOWNERS
│ ├── CODE_OF_CONDUCT.md
│ ├── CONTRIBUTING.md
│ ├── DISCUSSION_TEMPLATE
│ │ ├── announcements.yml
│ │ └── ideas.yml
│ ├── FUNDING.yml
│ ├── ISSUE_TEMPLATE
│ │ ├── BUG_FORM.yml
│ │ ├── ENHANCEMENT.yml
│ │ ├── FEATURE_REQUEST.md
│ │ ├── QUESTION.md
│ │ └── config.yml
│ ├── PULL_REQUEST_TEMPLATE.md
│ ├── SECURITY.md
│ ├── SUPPORT.md
│ └── workflows
│ └── markdown-lint.yml
├── .gitignore
├── .vscode
│ ├── cspell.json
│ ├── dictionaries
│ │ ├── project-words.txt
│ │ └── team-member.txt
│ ├── extensions.json
│ ├── javascriptreact.json
│ ├── markdownlint.json
│ ├── pkg.json
│ ├── settings.json
│ ├── tasks.json
│ └── template.code-snippets
├── CHANGELOG.md
├── LICENSE
├── README.md
├── docs
│ └── README.md
├── package.json
├── public
│ └── assets
│ └── images
├── src
│ └── index.js
├── template.code-workspace
└── tree
12 directories, 36 files
```
---
## License
This project is licensed under the [MIT License](LICENSE).
---
> [!Caution]
> Please update the readme and package.json as per your project.
> Make sure to remove or update the _CODEOWNERS_ file.
[template]: https://badgen.net/static/github/template?icon=github
[repo]: https://github.com/xkeshav/template
[license]: https://badgen.net/github/license/xkeshav/template
[issues]: https://badgen.net/github/open-issues/xkeshav/template
[PR]: https://badgen.net/github/prs/xkeshav/template
[commits]: https://badgen.net/github/commits/xkeshav/template/main?color=green