Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
danielklein-arch authored Aug 28, 2024
0 parents commit 0a2a030
Show file tree
Hide file tree
Showing 23 changed files with 12,672 additions and 0 deletions.
36 changes: 36 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Docs: https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
# - Checks for updates at the start of each Friday
# - Updates only explicitly defined dependencies
# - Creates commit message in compliance with conventional commits
# - Assignes `Dependencies` label to the pull request
# [npm]
# - Increases the minimum version to match the new version
version: 2
updates:
- package-ecosystem: github-actions
schedule:
interval: weekly
day: friday
time: '00:00'
allow:
- dependency-type: direct
commit-message:
prefix: 'chore: '
include: scope
labels:
- Dependencies
directory: /
- package-ecosystem: npm
directory: /
schedule:
interval: weekly
day: friday
time: '00:00'
allow:
- dependency-type: direct
commit-message:
prefix: 'chore: '
include: scope
labels:
- Dependencies
versioning-strategy: increase
37 changes: 37 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: CI

on:
push:
branches:
- dev

pull_request:
branches:
- dev

jobs:
codechecks:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- run: corepack enable
- uses: actions/setup-node@v4
with:
node-version: "20"
cache: "pnpm"
- name: Get pnpm store directory
shell: bash
run: |
echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
- uses: actions/cache@v4
with:
path: ${{ env.STORE_PATH }}
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
restore-keys: |
${{ runner.os }}-pnpm-store-
- name: Install Dependencies
run: pnpm install
- name: Typecheck
run: pnpm run typecheck
- name: Lint
run: pnpm run lint
16 changes: 16 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Deploy to production
on:
push:
tags:
- 'v*'

jobs:
Deploy-Production:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Release to production
run: |
git push origin HEAD:main -f
10 changes: 10 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
node_modules
*.log*
.nuxt
.nitro
.cache
.output
.env
dist
.DS_Store
.vercel
3 changes: 3 additions & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
shamefully-hoist=true
strict-peer-dependencies=false
shell-emulator=true
12 changes: 12 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"recommendations": [
"antfu.iconify",
"antfu.unocss",
"antfu.vite",
"antfu.goto-alias",
"csstools.postcss",
"dbaeumer.vscode-eslint",
"vue.volar",
"lokalise.i18n-ally"
]
}
17 changes: 17 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"prettier.enable": false,
"eslint.useFlatConfig": true,
"eslint.experimental.useFlatConfig": true,
"editor.codeActionsOnSave": {
"source.fixAll.eslint": "always"
},
"files.associations": {
"*.css": "postcss"
},
"editor.formatOnSave": false,
"css.validate": false,
"workbench.colorCustomizations": {
"statusBar.background": "#876FE8",
"statusBar.foreground": "#fff"
}
}
62 changes: 62 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Changelog


## v1.1.0

[compare changes](https://github.com/develit-io/develitesse-nuxt/compare/v0.0.1...v1.1.0)

### 🚀 Enhancements

- Change color settings ([1c27433](https://github.com/develit-io/develitesse-nuxt/commit/1c27433))
- Add nuxt-time ([55e223f](https://github.com/develit-io/develitesse-nuxt/commit/55e223f))
- Add --fix to lint-staged ([f3c777c](https://github.com/develit-io/develitesse-nuxt/commit/f3c777c))
- Test ([9a34cc8](https://github.com/develit-io/develitesse-nuxt/commit/9a34cc8))
- Revert test ([e9eeb83](https://github.com/develit-io/develitesse-nuxt/commit/e9eeb83))

### 🩹 Fixes

- Lint ([df66f68](https://github.com/develit-io/develitesse-nuxt/commit/df66f68))
- Enable eslint flat config ([b0b1c27](https://github.com/develit-io/develitesse-nuxt/commit/b0b1c27))

### 📖 Documentation

- Add corepack to readme ([4a1664c](https://github.com/develit-io/develitesse-nuxt/commit/4a1664c))
- Add corepack to readme ([9b16081](https://github.com/develit-io/develitesse-nuxt/commit/9b16081))
- Add corepack to readme ([3eb9d10](https://github.com/develit-io/develitesse-nuxt/commit/3eb9d10))

### 🏡 Chore

- Upgrade deps, change linter, add commitlint, stage-lint, update readme ([35b3c32](https://github.com/develit-io/develitesse-nuxt/commit/35b3c32))
- Update eslint ([63adcd2](https://github.com/develit-io/develitesse-nuxt/commit/63adcd2))
- Test tag released ([fd2c5b1](https://github.com/develit-io/develitesse-nuxt/commit/fd2c5b1))

### 🤖 CI

- Update actions and vercel rules ([94a321b](https://github.com/develit-io/develitesse-nuxt/commit/94a321b))
- **scripts:** Remove chnagelogen and call it by npx ([4fa9604](https://github.com/develit-io/develitesse-nuxt/commit/4fa9604))

### ❤️ Contributors

- Klein Petr ([@kleinpetr](http://github.com/kleinpetr))

## v0.0.1


### 🏡 Chore

- Deps update remove develitesse add devtools ([fe9600a](https://github.com/develit-io/develitesse-nuxt/commit/fe9600a))
- Update deps ([8336c37](https://github.com/develit-io/develitesse-nuxt/commit/8336c37))
- Add @nuxt/image module ([bf714b5](https://github.com/develit-io/develitesse-nuxt/commit/bf714b5))
- Upgrade libs chore: downgrade @antfu eslint to 0.40 feat: add default layout with loading indicator ([0df8b87](https://github.com/develit-io/develitesse-nuxt/commit/0df8b87))
- Upgrade deps to latest ([56b469f](https://github.com/develit-io/develitesse-nuxt/commit/56b469f))
- Update deps ([2a0db1d](https://github.com/develit-io/develitesse-nuxt/commit/2a0db1d))
- Add changelogen ([76a7bde](https://github.com/develit-io/develitesse-nuxt/commit/76a7bde))

### 🤖 CI

- Merge jobs to codechecks in order to speedup ci ([b746a1a](https://github.com/develit-io/develitesse-nuxt/commit/b746a1a))

### ❤️ Contributors

- Klein Petr ([@kleinpetr](http://github.com/kleinpetr))

43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Develit.io Nuxt Starter Template

## Pre-installed Icons
- [Heroicons](https://icones.js.org/collection/heroicons)
- [SVG Spinners](https://icones.js.org/collection/svg-spinners)

## Linter & Prettier
We don't use Prettier at all since it's also disabled in the `.vscode/settings`

We use [@nuxt/eslint](https://eslint.nuxt.com/) instead with enabled `config.stylistic`

## Page titles
you can define page title just by page meta
```ts
definePageMeta({ title: 'Blog' })
```

## Utilities & helper libraries
- [UnoCSS](https://github.com/antfu/unocss) - the instant on-demand atomic CSS engine.
- [@nuxt/image](https://image.nuxt.com/) - Resize and transform your images using built-in optimizer or your favorite images CDN.
- [magic-regexp](https://regexp.dev/) - A compiled-away, type-safe, readable RegExp alternative `createRegExp(exactly('foo/test.js').after('bar/'))`
- [nuxt-radash](https://nuxt.com/modules/radash) - lot of handy functions for array manipulating, etc `first`, `last`, `group`, `replace`, ...
- [@nuxt/color-mode](https://color-mode.nuxtjs.org/) - Dark and Light mode with auto detection made easy with Nuxt 🌗
- [nuxt-time](https://nuxt.com/modules/time) - SSR/SSG-safe rendering of any date/time (Prevents hydration mismatch)


## Contribution
> please read [Develit Contribution Guidlines](https://github.com/develit-io/develit-io/wiki/Contribution-Guidelines)
We respect the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) as we also use `commitlint` and
precommit hooks to check the right syntax

We also use `lint-staged` to run eslint against staged files

- Clone this repository
- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
- Install dependencies using `pnpm install`
- Use `pnpm dev` to start a local server

## IDE

We recommend using [VS Code](https://code.visualstudio.com/) with [Volar](https://github.com/johnsoncodehk/volar) to get the best experience (You might want to disable Vetur if you have it).

14 changes: 14 additions & 0 deletions app.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<script setup lang="ts">
const route = useRoute()
useHead({
title: () => (route.meta.title as string) || '',
titleTemplate: title => (title ? `${title} - Develitesse` : 'Develitesse'),
})
</script>

<template>
<NuxtLayout>
<NuxtPage />
</NuxtLayout>
</template>
3 changes: 3 additions & 0 deletions commitlint.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
extends: ['@commitlint/config-conventional'],
}
23 changes: 23 additions & 0 deletions eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import withNuxt from './.nuxt/eslint.config.mjs'

export default withNuxt(
{
rules: {
'@stylistic/space-before-function-paren': ['error', 'always'],
'@stylistic/arrow-parens': ['error', 'as-needed'],
'@typescript-eslint/no-explicit-any': 'off',
'@typescript-eslint/ban-types': 'off',
'@typescript-eslint/no-unused-vars': [
'warn',
{
argsIgnorePattern: '^_',
varsIgnorePattern: '^_',
caughtErrorsIgnorePattern: '^_',
},
],
'vue/multi-word-component-names': 'off',
'vue/max-attributes-per-line': 'off',
'vue/require-default-prop': 'off',
},
},
)
6 changes: 6 additions & 0 deletions layouts/default.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<template>
<div>
<NuxtLoadingIndicator />
<slot />
</div>
</template>
60 changes: 60 additions & 0 deletions nuxt.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
// https://nuxt.com/docs/api/configuration/nuxt-config
export default defineNuxtConfig({
modules: [
'@nuxt/test-utils/module',
'@nuxt/eslint',
'@vueuse/nuxt',
'@unocss/nuxt',
'@pinia/nuxt',
'@nuxtjs/color-mode',
'@nuxt/devtools',
'nuxt-radash',
'@nuxt/image',
],
eslint: {
config: {
stylistic: true,
},
},
sourcemap: {
server: true,
client: false,
},
app: {
head: {
htmlAttrs: { lang: 'en' },
title: 'Develitsse Nuxt',
},
pageTransition: false,
layoutTransition: false,
},
pinia: {
storesDirs: ['~/composables'],
},
experimental: {
// when using generate, payload js assets included in sw precache manifest
// but missing on offline, disabling extraction it until fixed
payloadExtraction: false,
typedPages: true,
componentIslands: true,
},
css: [
'@unocss/reset/tailwind.css',
],
colorMode: {
classSuffix: '',
},
nitro: {
preset: 'vercel',
esbuild: {
options: {
target: 'esnext',
},
},
},
vite: {
build: {
target: 'esnext',
},
},
})
Loading

0 comments on commit 0a2a030

Please sign in to comment.