mirror of
https://github.com/VueTubeApp/VueTube
synced 2024-12-22 16:30:20 +00:00
updated README to include linting
This commit is contained in:
parent
794a035aa0
commit
e0ecce6a11
1 changed files with 19 additions and 4 deletions
|
@ -6,19 +6,34 @@
|
|||
# install dependencies
|
||||
$ npm install
|
||||
|
||||
# serve with hot reload at localhost:3000
|
||||
# serve with hot reload
|
||||
$ npm run dev
|
||||
|
||||
# build for production and launch server
|
||||
# generate /android and /ios builds
|
||||
$ npm run build
|
||||
$ npm run start
|
||||
|
||||
# generate static project
|
||||
$ npm run generate
|
||||
|
||||
# lint files to avoid errors and formatting issues (do this before PR)
|
||||
$ npm run lint
|
||||
```
|
||||
|
||||
For detailed explanation on how things work, check out the [documentation](https://nuxtjs.org).
|
||||
|
||||
## Recommended VSCode Setup for Auto-Formatting
|
||||
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) `ext install dbaeumer.vscode-eslint`
|
||||
- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) `ext install esbenp.prettier-vscode`
|
||||
- [Vetur](https://marketplace.visualstudio.com/items?itemName=octref.vetur)
|
||||
|
||||
>`Ctrl(Cmd)` + `Shift` + `P` > Open Settings (JSON)
|
||||
```json
|
||||
"editor.formatOnSave": true,
|
||||
"editor.codeActionsOnSave": {
|
||||
"source.fixAll.eslint": true
|
||||
}
|
||||
"vetur.validation.template": false,
|
||||
```
|
||||
|
||||
## Special Directories
|
||||
|
||||
You can create the following extra directories, some of which have special behaviors. Only `pages` is required; you can delete them if you don't want to use their functionality.
|
||||
|
|
Loading…
Reference in a new issue