.yarn/cache and .pnp.* may be safely ignored, but you'll need to run yarn install to regenerate them between each branch switch - which would be optional otherwise, cf Zero-Installs.
.yarn/install-state.gz is an optimization file that you shouldn't ever have to commit. It simply stores the exact state of your project so that the next commands can boot without having to resolve your workspaces all over again.
.yarn/patches contain the patchfiles you've been generating with the yarn patch-commit command. You always want them in your repository, since they are necessary to install your dependencies.
.yarn/plugins and .yarn/releases contain the Yarn releases used in the current repository (as defined by yarn set version). You will want to keep them versioned (this prevents potential issues if, say, two engineers use different Yarn versions with different features).
.yarn/sdks contains the editor SDKs generated by PnPify. Whether to keep it in your repository or not is up to you; if you don't, you'll need to follow the editor procedure again on new clones. See Editor SDKs for more details.
.yarn/unplugged should likely always be ignored since they typically hold machine-specific build artifacts. Ignoring it might however prevent Zero-Installs from working (to prevent this, set enableScripts to false).
.yarn/versions is used by the version plugin to store the package release definitions. You will want to keep it within your repository.
yarn.lock should always be stored within your repository (even if you develop a library).
.yarnrc.yml (and its older counterpart, .yarnrc) are configuration files. They should always be stored in your project.
-
Install the Yarn global binary to its latest version:
npm install -g yarn
-
Move into your project folder:
cd ~/path/to/project
-
Run the following:
yarn set version berry
-
Install all modules via yarn: (if needed)
yarn
-
Install specific dependency via yarn:
yarn add {dependencyName}
npm install
- Note: Make an
.env
file from.env.example
yarn start
npm run start
|-- public/
| |-- favicon.ico -> Favicon
| |-- index.html -> Main HTML
| |-- logo.png
|-- src/
| | -- @core -> Vuexy Admin core files
| | -- @fake-db -> Fake Database for mocking axios requests (Fake API Calls)
| | -- assets -> Assets
| | | -- img
| | | -- scss
| | -- auth -> Your Authentication Files/Configuration
| | -- configs -> Template config files
| | -- layouts -> Your Layouts
| | -- navigation -> Vertical & Horizontal Navigation menu files
| | | -- horizontal
| | | -- vertical
| | -- redux -> Global Redux Store
| | | -- actions -> actions
| | | -- reducers -> reducers
| | | -- storeConfig -> Creates & Exports Store config
| | -- router -> App Router Files
| | | -- route -> Components Routes
| | | -- index.js -> Router index file
| | -- Utility -> Utilities & Context
| | -- Views -> View files for all pages
| | -- App.js -> Main App File
| | -- index.js -> App Index File
|-- package.json