Git Product home page Git Product logo

crud-vuetify-structured-template's Introduction

crud-vuetify-structured-template boilerplate

GitHub issues GitHub stars GitHub license code style: prettier

๐Ÿ’ป A full-featured Vuejs + Vuetify + Great structure project template + API Ready

๐Ÿ‘‰ It's using latest VueJS 2 and Vuetify 2

VueJS 3 + Vuetify 3 + Vite is coming soon ๐Ÿ˜Ž

Requirements

It's exactly the same as the VueJS projects, basicly you'll need a NodeJS installation. Check the links below out for more details:

Quick start

$ npm i -g @vue/cli-init
$ vue init huogerac/crud-vuetify-structured-template my-project
$ cd my-project
$ npm install   # Or yarn
$ npm run dev   # See the package.json / scripts

Note: The npm run dev will run the api mock and vuejs server, check the package.json out for running separeted which one.

Why using this boilerplate โ“

  • Focus on the business and creating value
  • Faster project setup
  • Standard project structure organization (easy to scale)
  • Easy to remove / rename features
  • DRY (I was doing those setup steps over and over again)
  • I don't want to be backend API dependent (Faster development using API Mocking)

What's Included ๐ŸŽ‰

  • VueJS (2) + Vuetify configured
  • Page inheritance (Layout)
    • Home Task's list
    • Create, Update and Delete Task
    • Error pages (404, 500)
  • Vue Router to be scalable
  • API Ready (using Axios)
  • API Mock (using json-server)
  • Pure components
  • Linter + Code style (Prettier)

Structure

โ”œโ”€โ”€ apiMock                ๐Ÿ‘‰ The sub-project for the API mock
โ”‚ย ย  โ””โ”€โ”€ server
โ”‚       db.json            ๐Ÿ‘‰ The API data (mock)
โ”œโ”€โ”€ public
โ”‚     favicon.ico
โ”œโ”€โ”€ package.json           ๐Ÿ‘‰ Project/Package Manifest
โ”œโ”€โ”€ .prettierrc.js         ๐Ÿ‘‰ Code Style
โ”œโ”€โ”€ .env                   ๐Ÿ‘‰ Set environment var for development
โ””โ”€โ”€ src
    โ”œโ”€โ”€ router             ๐Ÿ‘‰ #1 App routes
    โ”‚   โ”œโ”€โ”€ index.js
    โ”‚   โ””โ”€โ”€ tasks.api.js       ๐Ÿ‘‰ Routers by context
    โ”œโ”€โ”€ pages              ๐Ÿ‘‰ #2 App pages (App pages/views)
    โ”‚ย ย  โ”œโ”€โ”€ layouts            ๐Ÿ‘‰ Pages bases
    โ”‚   โ”‚   โ””โ”€โ”€ Public.vue
    โ”‚ย ย  โ””โ”€โ”€ public             ๐Ÿ‘‰ Pages by context
    โ”‚       โ”œโ”€โ”€ 500.vue
    โ”‚       โ””โ”€โ”€ Home.vue       ๐Ÿ‘‰ VueJS "SMART" components
    โ”œโ”€โ”€ components         ๐Ÿ‘‰ #3 VueJS "DUMP" components
    โ”‚ย ย  โ””โ”€โ”€ visual             ๐Ÿ‘‰ Pure components**
    โ”œโ”€โ”€ api                ๐Ÿ‘‰ #4 API folder
    โ”‚   โ”œโ”€โ”€ index.js
    โ”‚   โ””โ”€โ”€ tasks.api.js       ๐Ÿ‘‰ API endpoints by context
    โ”œโ”€โ”€ mixins             ๐Ÿ‘‰ Anything used cross components
    โ”‚   โ””โ”€โ”€ ApiResponse.vue
    โ”œโ”€โ”€ filters            ๐Ÿ‘‰ VueJS template filters
    โ”‚   โ””โ”€โ”€ dateFilter.js
    โ”œโ”€โ”€ assets
    โ”‚   โ””โ”€โ”€ some-image.jpg
    โ””โ”€โ”€ plugins
      โ””โ”€โ”€ vuetify.js

Screenshots

Contribute ๐Ÿš€

Any help is more than welcome...

  • ๐Ÿ‘‰ It could be an Issue
  • ๐Ÿ’ป It could be using it and give a feedback
  • ๐ŸŒŸ It could be a github star
  • ๐Ÿค” It could be a question ( Use the Issues )
  • ๐Ÿค” If you hate this project, feel free to tell us what is wrong with it

Alternatives โš™๏ธ

  • If you know great vuejs project templates, please, add it here

Extra Documentation

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.