Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release new structure #243

Merged
merged 2 commits into from
Dec 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
44 changes: 0 additions & 44 deletions .editorconfig

This file was deleted.

File renamed without changes.
File renamed without changes.
3 changes: 1 addition & 2 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@

module.exports = {
export default {
root: true,
env: {
node: true
},
'extends': [
'plugin:vue/essential',
"plugin:prettier/recommended",
'eslint:recommended'
],
parserOptions: {
Expand Down
873 changes: 0 additions & 873 deletions .yarn/releases/yarn-3.5.1.cjs

This file was deleted.

874 changes: 0 additions & 874 deletions .yarn/releases/yarn-3.6.0.cjs

This file was deleted.

2 changes: 0 additions & 2 deletions .yarnrc.yml

This file was deleted.

61 changes: 61 additions & 0 deletions CasaOS-UI.code-workspace
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
{
"folders": [
{
"path": ".",
},
],
"settings": {
"files.associations": {
"*.css": "tailwindcss",
},
"editor.quickSuggestions": {
"strings": "on",
},
// Disable the default formatter, use eslint instead
"editor.formatOnSave": false,
"editor.codeActionsOnSave": {
"source.fixAll.eslint": "explicit",
"source.organizeImports": "never"
},
"tailwindCSS.classAttributes": [
"class",
"className",
"ngClass",
".*Styles*"
],
"tailwindCSS.experimental.classRegex": [
// class: "" / class: ''
"\\bclass:\\s*[\"']([^\"']*)[\"']",
// class: []
"\\bclass:\\s*\\[[^\\]]*\\]",
// class: {}
"\\bclass:\\s*\\{[^}]*\\}",
],
// Silent the stylistic rules in you IDE, but still auto fix them
// For i18n-ally
"i18n-ally.localesPaths": [
"src/assets/lang"
],
// Enable eslint for all supported languages
"i18n-ally.keystyle": "nested",
"[vue]": {
"editor.defaultFormatter": "octref.vetur"
}
},
"extensions": {
"recommendations": [
// For vue2 development experience
"octref.vetur",
// For lint and format
"dbaeumer.vscode-eslint",
// For npm packages management
"idered.npm",
// For i18n support
"lokalise.i18n-ally",
// For better development experience
"christian-kohler.path-intellisense",
"formulahendry.auto-close-tag",
"formulahendry.auto-rename-tag",
],
},
}
27 changes: 8 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
# How to develop this project

## Prerequisites
1. Node 16 ([installation instructions](https://github.com/nvm-sh/nvm?tab=readme-ov-file#usage))
2. Yarn@3.6.0 ([installation instructions](https://yarnpkg.com/getting-started/install))
1. Node 18 ([installation instructions](https://github.com/nvm-sh/nvm?tab=readme-ov-file#usage))
2. pnpm@9.0.6 ([installation instructions](https://pnpm.io/installation))

## Environment variables
If you want to connect dev UI version to your local CasaOS server, you will need to set up a couple of env variables:
Expand All @@ -17,39 +17,29 @@ If you want to connect dev UI version to your local CasaOS server, you will need

## Set up dev server
```shell
# install tool
yarn global add turbo

# install dependencies
yarn install
pnpm install

# build
yarn dev
pnpm dev
```

# How to build this project

```shell
# install tool
yarn global add turbo

# install dependencies
yarn install
pnpm install

# build
yarn build
pnpm build
```

# How to test this project

```shell
yarn test
pnpm test
```

This project uses `vitest` for unit tests.

# TODO how to deploy this project

# How to contribute to this project

CasaOS is a community-driven open source project and the people involved are CasaOS users. That means CasaOS will always
Expand All @@ -58,7 +48,6 @@ need contributions from community members just like you!
- See <https://wiki.casaos.io/en/contribute> for ways of contribution to CasaOS
- See <https://wiki.casaos.io/en/contribute/development> if you want to be involved in code contribution specificially

# TODO how to license this project

# How to contact this project

Expand All @@ -76,4 +65,4 @@ reshape the digital home experience like never before.

**A warm welcome for you to get help or share great ideas in the [Discord](https://discord.gg/knqAbbBbeX)!**

[![Discord Card](https://discordapp.com/api/guilds/884667213326463016/widget.png?style=banner2)](https://discord.gg/knqAbbBbeX)
[![Discord Card](https://discordapp.com/api/guilds/884667213326463016/widget.png?style=banner2)](https://discord.gg/knqAbbBbeX)
18 changes: 18 additions & 0 deletions babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
module.exports = {
presets: [
"@vue/cli-plugin-babel/preset",
[
"@babel/preset-env",
{
useBuiltIns: "entry",
corejs: 3,
},
],
[
"@babel/preset-typescript", // 引用Typescript插件
{
allExtensions: true, // 支持所有文件扩展名,否则在vue文件中使用ts会报错
},
],
],
};
12 changes: 12 additions & 0 deletions eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
// @ts-check
import antfu from '@antfu/eslint-config'

export default antfu(
{
// Configures for antfu's config
typescript: false,
vue: true,
unocss: false,
markdown: true,
},
)
File renamed without changes.
Loading
Loading