wemake-vue-template
  • Introduction
  • Architecture
  • FAQ
  • Development
  • Configuration
  • Editors
  • TypeScript
  • Vue
  • Styles
  • Linting
  • Testing
  • Docker
  • GitLab CI
  • QA
  • Production
Powered by GitBook
On this page
  • Client
  • Tests

Architecture

PreviousIntroductionNextFAQ

Last updated 5 years ago

Here we define all files and folders that are used in this project.

  • README.md - main readme file, it specifies the entry point to the project's documentation

  • - main file of the project. It defines the project's dependencies and scripts. It is also used to provide meta-data for many other tools

  • package-lock.json - lock file for dependencies. It is used to install exactly the same versions of dependencies on each build

  • - the main configuration file for Nuxt. It contains a list of installed plugins and other configuration. It is also used to specify how to build this project

  • - is used to specify how to deal with the ts files in this project. We can introduce new ts features by adding new configuration

  • - configuration file for ts, js, and vue files linting

  • - configuration file for stylelint, which is used for linting styles

  • - file with node version specification. Make sure that you have it installed, or otherwise, the project will not work at all

  • - file with format specification. You need to install the required plugin for your IDE in order to enable it

  • - file that specifies what should we commit into the repository and we should not

  • docker/ - this folder contains Dockerfiles and utility scripts that are used for development and quality assurance

  • - this the file specifies docker services that are needed for development and testing

  • .dockerignore - specifies what files should not be copied to the docker image

  • - GitLab CI configuration file. It basically defines what to do with your project after pushing it to the repository. Currently it is used for testing and releasing a docker image

  • jest.config.js - this file is used to configure

  • - vscode IDE integration. We store different settings, plugins, and tasks inside this folder

Client

  • components/ - the components directory contains your Vue components, Nuxt doesn't supercharge these components

  • logic/ - this directory contains your Application Logics. You should put everything that is considered business logic here

Tests

  • fixtures/ - this folder contains utility files that are used for testing

  • .eslintrc.js - this file extends linting rules for testing

  • jest-shims.d.ts - file to import TypeScript types into current context

assets/ - this directory contains your images, fonts, or any other files that you want by webpack

layouts/ - this directory contains your

middleware/ - this directory contains your . The middleware lets you define custom function to be run before rendering a page or a group of pages (layouts)

pages/ - this directory contains your application routes. We rely on Nuxt's

plugins/ - this directory contains your custom for Nuxt

static/ - the files directory. These files are not processed by any loaders and just copied as-is

store/ - this directory contains your files

shims/ - this directory contains TypeScript , feel free to extend it with your own types

package.json
nuxt.config.ts
tsconfig.json
.eslintrc.js
stylelint.config.js
.nvmrc
.editorconfig
.gitignore
docker-compose.yml
.gitlab-ci.yml
jest
.vscode/
to be processed
Application Layouts
Application Middleware
builtin routing
plugins
static
Vuex Store
declaration files