Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
beefchimi authored Jan 23, 2023
0 parents commit 245e61e
Show file tree
Hide file tree
Showing 26 changed files with 12,124 additions and 0 deletions.
20 changes: 20 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
root = true

[*]
charset = utf-8
end_of_line = lf
indent_size = 2
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true

# Markdown syntax specifies that trailing whitespaces can be meaningful,
# so let’s not trim those. e.g. 2 trailing spaces = linebreak (<br />)
# See https://daringfireball.net/projects/markdown/syntax#p
[*.md]
trim_trailing_whitespace = false

# Disable trailing whitespace removal in diff files,
# where whitespace is meaningful
[*.diff]
trim_trailing_whitespace = false
7 changes: 7 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
node_modules/

# Ignore artifacts:
build/
coverage/
dist/
storybook-static/
10 changes: 10 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"extends": [
"plugin:@beefchimi/esnext",
// "plugin:@beefchimi/react",
"plugin:@beefchimi/typescript",
"plugin:@beefchimi/jest",
// "plugin:@beefchimi/node",
"plugin:@beefchimi/prettier"
]
}
19 changes: 19 additions & 0 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
👽️ dependency:
- any: ['**/package*', '**/yarn.lock', '.pnp.*']
📝 documentation: '**/!(CHANGELOG|LICENSE|MIGRATION).@(md|mdx)'
🔖 release: '**/CHANGELOG.md'
🧪 testing: '**/*.@(spec|test).@(js|jsx|ts|tsx)'
🔧 tooling:
- any:
[
'*',
'.github/**/*',
'.vscode/**/*',
'.yarn*',
'.yarn/**/*',
'config/**/*',
'scripts/**/*',
'!package*',
'!yarn.lock',
'!*.@(md|mdx)',
]
18 changes: 18 additions & 0 deletions .github/workflows/labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Labeler
on: [pull_request_target]

jobs:
triage:
runs-on: ubuntu-latest

permissions:
contents: read
pull-requests: write

steps:
- uses: actions/checkout@v2

- name: Apply PR labels
uses: actions/labeler@v3
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
26 changes: 26 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Lint
on: [push]

jobs:
lint:
name: Lint the codebase
runs-on: ubuntu-latest

steps:
- name: Checkout repo
uses: actions/checkout@v2

- name: Setup Node 17.x and write .npmrc
uses: actions/setup-node@v2
with:
version: 17.x
registry-url: 'https://npm.pkg.github.com'
scope: '@beefchimi'

- name: Install Dependencies and build (with cache)
uses: bahmutov/npm-install@v1
env:
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Lint
run: npm run lint
26 changes: 26 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Test
on: [push]

jobs:
test:
name: Build and run Jest tests
runs-on: ubuntu-latest

steps:
- name: Checkout repo
uses: actions/checkout@v2

- name: Setup Node 17.x and write .npmrc
uses: actions/setup-node@v2
with:
version: 17.x
registry-url: 'https://npm.pkg.github.com'
scope: '@beefchimi'

- name: Install Dependencies and build (with cache)
uses: bahmutov/npm-install@v1
env:
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Test
run: npm run test
95 changes: 95 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
# OS files
.DS_Store
._*

# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent

# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk

# Caches
.cache
.eslintcache
.sass-cache
*.tsbuildinfo

# Build
build
dist
dist-ssr
storybook-static

# Environment
.env
.env.test
.env.production

# Vite
*.local

# Secrets
secrets.json

# Maps
# *.*.map

# Coverage
coverage
lib-cov
*.lcov

# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

# Reports
assets-manifest.json
bundle-report.html
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Dependencies
.lock-wscript
.node_repl_history
.npm
.yarn-integrity
node_modules
web_modules/

# Output of 'npm pack'
*.tgz

# Yarn common
.yarn/*
!.yarn/patches
!.yarn/plugins
!.yarn/releases
!.yarn/sdks
!.yarn/versions

# Yarn Zero-Installs
# !.yarn/cache

# Yarn Non-Zero
.pnp.*
62 changes: 62 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Root dotfiles
.DS_Store
.git
.babelrc
.editorconfig
.eslintignore

# Caches
.cache
.eslintcache
.sass-cache
*.tsbuildinfo

# Dependencies
.lock-wscript
.node_repl_history
.npm
.npmignore
.pnp.*
.yarn
.yarn-integrity
package-lock.json
yarn.lock
node_modules
web_modules/

# Build
build
# dist
dist-ssr
storybook-static

# Environment
.env
.env.test
.env.production

# Coverage
coverage
lib-cov
*.lcov

# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

# Reports
assets-manifest.json
bundle-report.html
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Other
*.local
# *.*.map
# config
secrets.json
tests
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
17.3.0
14 changes: 14 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"recommendations": [
"christian-kohler.npm-intellisense",
"christian-kohler.path-intellisense",
"codezombiech.gitignore",
"DavidAnson.vscode-markdownlint",
"dbaeumer.vscode-eslint",
"EditorConfig.editorconfig",
"esbenp.prettier-vscode",
"Gruntfuggly.todo-tree",
"stylelint.vscode-stylelint",
"mrmlnc.vscode-scss"
]
}
25 changes: 25 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"css.validate": false,
"scss.validate": false,
"javascript.validate.enable": false,
"stylelint.enable": true,
"editor.codeActionsOnSave": {
"source.fixAll": true
},
"editor.formatOnSave": true,
"editor.defaultFormatter": "esbenp.prettier-vscode",
"eslint.validate": ["javascript", "javascriptreact", "typescript", "typescriptreact"],
"typescript.tsdk": "./node_modules/typescript/lib",
"typescript.enablePromptUseWorkspaceTsdk": true,
"files.exclude": {
"**/.git": true,
"**/.DS_Store": true,
"lib": true
},
"search.exclude": {
"**/node_modules": true,
"lib": true,
"dist/": true,
"storybook-static/": true
}
}
7 changes: 7 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# [ISC License](https://spdx.org/licenses/ISC)

Copyright (c) 2022, Curtis Dulmage <[email protected]>

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Template: Common

[![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg)](https://opensource.org/licenses/ISC)

This repository serves as a template for common web projects.
Loading

0 comments on commit 245e61e

Please sign in to comment.