mirror of
https://github.com/VueTubeApp/VueTube
synced 2024-11-18 09:15:12 +00:00
84 lines
3.3 KiB
Markdown
84 lines
3.3 KiB
Markdown
# VueTube
|
|
|
|
## Build Setup
|
|
|
|
```bash
|
|
# install dependencies
|
|
$ npm install
|
|
|
|
# serve with hot reload
|
|
$ npm run dev
|
|
|
|
# generate /android and /ios builds
|
|
$ npm run build
|
|
$ npm run start
|
|
$ 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.
|
|
|
|
### `assets`
|
|
|
|
The assets directory contains your uncompiled assets such as Stylus or Sass files, images, or fonts.
|
|
|
|
More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/assets).
|
|
|
|
### `components`
|
|
|
|
The components directory contains your Vue.js components. Components make up the different parts of your page and can be reused and imported into your pages, layouts and even other components.
|
|
|
|
More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/components).
|
|
|
|
### `layouts`
|
|
|
|
Layouts are a great help when you want to change the look and feel of your Nuxt app, whether you want to include a sidebar or have distinct layouts for mobile and desktop.
|
|
|
|
More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/layouts).
|
|
|
|
|
|
### `pages`
|
|
|
|
This directory contains your application views and routes. Nuxt will read all the `*.vue` files inside this directory and setup Vue Router automatically.
|
|
|
|
More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/get-started/routing).
|
|
|
|
### `plugins`
|
|
|
|
The plugins directory contains JavaScript plugins that you want to run before instantiating the root Vue.js Application. This is the place to add Vue plugins and to inject functions or constants. Every time you need to use `Vue.use()`, you should create a file in `plugins/` and add its path to plugins in `nuxt.config.js`.
|
|
|
|
More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/plugins).
|
|
|
|
### `static`
|
|
|
|
This directory contains your static files. Each file inside this directory is mapped to `/`.
|
|
|
|
Example: `/static/robots.txt` is mapped as `/robots.txt`.
|
|
|
|
More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/static).
|
|
|
|
### `store`
|
|
|
|
This directory contains your Vuex store files. Creating a file in this directory automatically activates Vuex.
|
|
|
|
More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/store).
|