Git Product home page Git Product logo

nuxt-deluxe-starter's Introduction

nuxt-deluxe-starter

Welcome!

The point of this repo is to achieve two things:

  1. Make an opensource template encompassing basic essentials of all webapps in Nuxt. Such as...

    • Responsive Navbar
    • Effects, like AOS, animate.css, etc
    • State and stateful transactions
    • Authentication (if not implemented in the repo, then really clear instructions on how to get this set up with services like AWS Amplify)
    • Maps
    • Graphs / Charts
  2. Document and explain clearly all the functionalities of what's been put inside this app

    • So for things like the vuex store, there's a detailed yet concise explanation of how various actions / getters / mutations are used and what a general way to call them is
    • Links to further reading and explanations are listed when appropriate

Contributing and Style guidelines

I'd like for this repo to follow two CSS rules

1. Bulma classes
2. BEM classes

For all logic use the following rules:

1. Variable names should use camelCase.
2. Document all functions and functionality.

For making pull requests, assign yourself to an issue and then make a PR against the master branch

Build Setup (Nuxt pregenerated MD)

# install dependencies
$ yarn install

# serve with hot reload at localhost:3000
$ yarn dev

# build for production and launch server
$ yarn build
$ yarn start

# generate static project
$ yarn generate

For detailed explanation on how things work, check out Nuxt.js docs.

nuxt-deluxe-starter's People

Contributors

mepda avatar

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.