Skip to content

Commit

Permalink
Init commit
Browse files Browse the repository at this point in the history
  • Loading branch information
digikid committed Jul 24, 2022
0 parents commit 80cd46c
Show file tree
Hide file tree
Showing 45 changed files with 9,568 additions and 0 deletions.
7 changes: 7 additions & 0 deletions .browserslistrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
last 2 versions
Firefox ESR
> 0.5%
ie >= 9
Safari >= 8
iOS >= 8
Android >= 4
5 changes: 5 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[*.{js,jsx,ts,tsx,vue}]
indent_style = space
indent_size = 2
trim_trailing_whitespace = true
insert_final_newline = true
5 changes: 5 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
dist
docs
public
index.html
vite.config.ts
26 changes: 26 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"extends": [
"plugin:vue/vue3-recommended",
"@vue/typescript/recommended",
"airbnb-base"
],
"plugins": [
"@typescript-eslint"
],
"env": {
"node": true,
"browser": true,
"es6": true
},
"settings": {
"import/resolver": {
"typescript": {}
}
},
"ignorePatterns": [
"*.config.js"
],
"rules": {
"import/prefer-default-export": "off"
}
}
24 changes: 24 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*

node_modules
dist
dist-ssr
*.local

# Editor directories and files
.vscode/*
!.vscode/extensions.json
.idea
.DS_Store
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
dist
6 changes: 6 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"useTabs": false,
"singleQuote": true,
"trailingComma": "es5",
"semi": false
}
2 changes: 2 additions & 0 deletions .stylelintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
dist
public
19 changes: 19 additions & 0 deletions .stylelintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"extends": ["stylelint-config-standard"],
"rules": {
"at-rule-no-unknown": [
true,
{
"ignoreAtRules": [
"tailwind",
"apply",
"variants",
"responsive",
"screen"
]
}
],
"declaration-block-trailing-semicolon": null,
"no-descending-specificity": null
}
}
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Release Notes

[1.0.0]: https://github.com/digikid/vite-vue-project/releases/tag/1.0.0

## [1.0.0] - 2022-07-24

Initial release
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022 Alexander Dovlatov

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
87 changes: 87 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
<div align="center">
<img alt="Vite + Vue Project" src="https://github.com/digikid/vite-vue-project/raw/main/public/images/logo.png" height="117" />
<h1>Vite + Vue Project</h1>
<p>Modern starter template for Vite using Vue and TypeScript</p>
<img src="https://img.shields.io/github/release/digikid/vite-vue-project.svg?style=flat-square&logo=appveyor" alt="Release version">
<img src="https://img.shields.io/github/languages/top/digikid/vite-vue-project.svg?style=flat-square&logo=appveyor" alt="TypeScript">
<img src="https://img.shields.io/github/license/digikid/vite-vue-project.svg?style=flat-square&logo=appveyor" alt="MIT License">
<p>
<a href="https://github.com/digikid/vite-vue-project/blob/main/README.md">English</a> | <a href="https://github.com/digikid/vite-vue-project/blob/main/README.ru-RU.md">Русский</a></p>
</div>

## About

This starter template should help get you started developing with [Vue](https://vuejs.org/), [TypeScript](https://www.typescriptlang.org/) and set of modern UI tools in [Vite](https://vitejs.dev/).

## Additional Tools

### CSS Framework

Tailwind CSS is basically a utility-first CSS framework for rapidly building custom user interfaces. It is a highly customizable, low-level CSS framework that gives you building blocks you need to build bespoke designs without any annoying opinionated styles you have to fight to override.

- [Tailwind CSS](https://tailwindcss.com/)

### CSS Plugins

This template also includes first-party plugins needed for [Tailwind UI](https://tailwindui.com/):

- [forms](https://github.com/tailwindlabs/tailwindcss-forms)
- [typography](https://github.com/tailwindlabs/tailwindcss-typography)
- [line-clamp](https://github.com/tailwindlabs/tailwindcss-line-clamp)
- [aspect-ratio](https://github.com/tailwindlabs/tailwindcss-aspect-ratio)

[PostCSS](https://github.com/postcss/postcss) plugin to parse CSS and add vendor prefixes to CSS rules using values from [Can I Use](https://caniuse.com/). It is recommended by Google and used in Twitter and Alibaba.

- [Autoprefixer](https://github.com/postcss/autoprefixer)

### UI Components

Completely unstyled, fully accessible UI components, designed to integrate beautifully with Tailwind CSS.

- [Headless UI](https://headlessui.com/)

### Fonts

Inter is a typeface carefully crafted & designed for computer screens.

- [Inter var](https://github.com/rsms/inter) (self-hosted)

### Coding Style

ESLint is an open source project that helps you find and fix problems with your JavaScript code.

- [ESLint](https://eslint.org/) + [Airbnb Config](https://github.com/airbnb/javascript)

A mighty, modern linter that helps you avoid errors and enforce conventions in your styles.

- [Stylelint](https://stylelint.io/) + [Standard Config](https://github.com/stylelint/stylelint-config-standard)

## Usage

### GitHub Template

[Create a repo from this template on GitHub](https://github.com/digikid/vite-vue-project/generate)

### Local Install

```sh
npx degit digikid/vite-vue-project my-project
cd my-project
npm i
```

## Path Aliases

By default, all path aliases declared in `tsconfig.json` file are imported into the Vite config, so you don't have to declare them twice.

## Browser Support

Only the latest versions of major browsers (e.g. Chrome, Firefox, Safari, Edge etc) are supported.

<img src="https://github.com/digikid/vite-vue-project/raw/main/public/images/chrome.svg" width="64" height="64" alt="Chrome"> <img src="https://github.com/digikid/vite-vue-project/raw/main/public/images/firefox.svg" width="64" height="64" alt="Firefox"> <img src="https://github.com/digikid/vite-vue-project/raw/main/public/images/edge.svg" width="64" height="64" alt="Edge"> <img src="https://github.com/digikid/vite-vue-project/raw/main/public/images/safari.svg" width="64" height="64" alt="Safari"> <img src="https://github.com/digikid/vite-vue-project/raw/main/public/images/opera.svg" width="64" height="64" alt="Opera">

**There is no support for any version of IE.**

## License

[The MIT License (MIT)](LICENSE)
87 changes: 87 additions & 0 deletions README.ru-RU.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
<div align="center">
<img alt="Vite + Vue Project" src="https://github.com/digikid/vite-vue-project/raw/main/public/images/logo.png" height="117" />
<h1>Vite + Vue Project</h1>
<p>Стартовый шаблон для сборки приложения на Vue и TypeScript</p>
<img src="https://img.shields.io/github/release/digikid/vite-vue-project.svg?style=flat-square&logo=appveyor" alt="Release version">
<img src="https://img.shields.io/github/languages/top/digikid/vite-vue-project.svg?style=flat-square&logo=appveyor" alt="TypeScript">
<img src="https://img.shields.io/github/license/digikid/vite-vue-project.svg?style=flat-square&logo=appveyor" alt="MIT License">
<p>
<a href="https://github.com/digikid/vite-vue-project/blob/main/README.md">English</a> | <a href="https://github.com/digikid/vite-vue-project/blob/main/README.ru-RU.md">Русский</a></p>
</div>

## О шаблоне

Этот шаблон позволяет без предварительной настройки начать разработку в [Vite]( https://vitejs.dev/) с использованием [Vue](https://vuejs.org/), [TypeScript](https://www.typescriptlang.org/) и набора современных UI инструментов.

## Что включено

### CSS фреймворк

CSS-фреймворк, предлагающий обширный каталог классов и инструментов для облегчения стилизации сайта или приложения.

- [Tailwind CSS](https://tailwindcss.com/)

### CSS плагины

Этот шаблон также включает набор плагинов, необходимых для работы [Tailwind UI](https://tailwindui.com/):

- [forms](https://github.com/tailwindlabs/tailwindcss-forms)
- [typography](https://github.com/tailwindlabs/tailwindcss-typography)
- [line-clamp](https://github.com/tailwindlabs/tailwindcss-line-clamp)
- [aspect-ratio](https://github.com/tailwindlabs/tailwindcss-aspect-ratio)

Утилита нового поколения для добавления префиксов к экспериментальным свойствам из CSS 3 на основе [Can I Use](https://caniuse.com/).

- [Autoprefixer](https://github.com/postcss/autoprefixer)

### UI компоненты

Полностью не стилизованные компоненты, разработанные для интеграции с Tailwind CSS.

- [Headless UI](https://headlessui.com/)

### Шрифты

Шрифт, разработанный специально для экранов компьютеров и рекомендуемый к использованию разработчиками Tailwind CSS.

- [Inter var](https://github.com/rsms/inter) (self-hosted)

### Проверка кода

Линтер с открытым исходным кодом, который помогает находить и устранять проблемы с JavaScript кодом.

- [ESLint](https://eslint.org/) + [Airbnb Config](https://github.com/airbnb/javascript)

Мощный современный линтер, который помогает избежать ошибок и обеспечить соблюдение соглашений в файлах стилей.

- [Stylelint](https://stylelint.io/) + [Standard Config](https://github.com/stylelint/stylelint-config-standard)

## Использование

### Шаблон GitHub

[Создайте репозиторий из этого шаблона на GitHub](https://github.com/digikid/vite-vue-project/generate)

### Локальная установка

```sh
npx degit digikid/vite-vue-project my-project
cd my-project
npm i
```

## Псевдонимы путей (Path aliases)

По умолчанию все псевдонимы путей, объявленные в файле `tsconfig.json`, импортируются в конфигурацию Vite, поэтому вам не нужно объявлять их дважды.

## Поддержка браузерами

Поддерживаются только последние версии основных браузеров (Chrome, Firefox, Safari, Edge и т.д.).

<img src="https://github.com/digikid/vite-vue-project/raw/main/public/images/chrome.svg" width="64" height="64" alt="Chrome"> <img src="https://github.com/digikid/vite-vue-project/raw/main/public/images/firefox.svg" width="64" height="64" alt="Firefox"> <img src="https://github.com/digikid/vite-vue-project/raw/main/public/images/edge.svg" width="64" height="64" alt="Edge"> <img src="https://github.com/digikid/vite-vue-project/raw/main/public/images/safari.svg" width="64" height="64" alt="Safari"> <img src="https://github.com/digikid/vite-vue-project/raw/main/public/images/opera.svg" width="64" height="64" alt="Opera">

**Ни одна версия IE не поддерживается.**

## Лицензия

[The MIT License (MIT)](LICENSE)
15 changes: 15 additions & 0 deletions index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<title>Vite + Vue Project</title>
<link rel="icon" type="image/x-icon" href="images/vite.svg"/>
<link rel="stylesheet" href="fonts/inter.css"/>
<link rel="preload" type="font/woff2" as="font" crossorigin="anonymous" href="fonts/Inter-roman.var.woff2"/>
</head>
<body>
<div id="app"></div>
<script src="/src/main.ts" type="module"></script>
</body>
</html>
Loading

0 comments on commit 80cd46c

Please sign in to comment.