Skip to content

morellexf13/tuto

Repository files navigation


🍦

Vanilla Tuto (Deprecated)


A Vue 2 Starter Boilerplate with Vue Router 3, Vuex 3, Webpack 5, Axios, Jest and More.

Version License Package Monthly Downloads Docs

Website

Tuto is the short of Tutorial and the best/easier way to start creating a SPA using the best frameworks out there!


πŸ‘¨πŸ»β€πŸ« Basic topics


πŸ’Ž Features

  • Basic login/logout state definition using Vuex Store v3.x.
  • Basic Store configured using Vuex and Persist Plugin (stores/index.js).
  • Basic "Home" and "Login" pages defined (src/pages/).
  • Basic router configuration defined (/router.js).
  • Basic GET request using Axios (Spotify Tracker API). This request needs an Authorization Bearer Token . For security purposes you can just set this token on environment files.
  • Environment file example.
  • Jest configuration defined.
  • API Unit test included.
  • Path alias defined (webpack.config.js).
  • GitHub actions workflow example defined.

πŸ› Project Structure

tuto
β”œβ”€ .babelrc
β”œβ”€ LICENSE
β”œβ”€ README.md
β”œβ”€ babel.config.json
β”œβ”€ jest.config.js // πŸƒ Unit tests configuration
β”œβ”€ jsconfig.json
β”œβ”€ package-lock.json
β”œβ”€ package.json
β”œβ”€ router.js // 🧭 Handle page routes
β”œβ”€ src
β”‚  β”œβ”€ App.vue
β”‚  β”œβ”€ assets
β”‚  β”‚  β”œβ”€ css
β”‚  β”‚  β”‚  └─ index.css // 🎨 Main stylesheet file
β”‚  β”‚  β”œβ”€ favicon.ico
β”‚  β”‚  β”œβ”€ logo.png
β”‚  β”‚  β”œβ”€ screenshots
β”‚  β”‚  β”‚  └─ login.png
β”‚  β”‚  └─ scripts
β”‚  β”‚     └─ api.js // πŸ“‘ Handle api calls
β”‚  β”œβ”€ components
β”‚  β”‚  β”œβ”€ MainSection.vue
β”‚  β”‚  └─ UserSessionLink.vue
β”‚  β”œβ”€ index.html
β”‚  β”œβ”€ main.js // πŸͺ΄ Application's entry point
β”‚  └─ pages
β”‚     β”œβ”€ Home.vue
β”‚     β”œβ”€ Login.vue
β”‚     └─ SpotifyTracker.vue
β”œβ”€ stores
β”‚  └─ index.js // πŸ’Ύ Save general state of the app
β”œβ”€ tests // πŸƒ Unit tests
β”‚  └─ unit
β”‚     └─ spotify.spec.js
β”œβ”€ vue.config.js // 🍦 Vue framework setup
└─ webpack.config.js // πŸ“¦ Bundler setup, alias and more


πŸš€ Install

Install it locally in your project

npm install

npm run dev

πŸ§ͺ Unit tests

npm run test