Giter Club home page Giter Club logo

cms-vue-boilerplate's Introduction

⚠️ This project is no longer actively maintained and is read only ⚠️

cms-vue-boilerplate [beta]

Boilerplate Vue project for creating apps using modules on the HubSpot CMS

Getting Started

For more information on local development tools, see Local Development Tooling: Getting Started

Configuration

Set up HubSpot CMS CLI (@hubspot/cms-cli)

  • A config file named hubspot.config.yml will also be needed. The config can be at the project level or higher up in the directory tree.
  • Be sure to set a defaultPortal in your hubspot.config.yml to which you'd like the built app files to sync.

Install

  • Run npm install or yarn install to install needed dependencies.

Running

  • Run npm start or yarn start to automatically upload your project to defaultPortal.
  • Create a page from default theme, or any drag-and-drop (dnd_area) enabled template in your portal, and add the module(see snippet below).
    {% module "cms_vue_boilerplate" path="./cms-vue-boilerplate/modules/app" label="CMS Vue Boilerplate" %}
    

package.json scripts

  • start : Builds project with webpack, uploads to your defaultPortal specified in hubspot.config.yml and watches for changes via @hubspot/webpack-cms-plugins/HubSpotAutoUploadPlugin.
  • build : Clears /dist contents and builds project into /dist.
  • deploy : Clears /dist contents, builds project into /dist, and uploads to via @hubspot/cms-cli.
  • lint : Lints CSS, JS, and JSON files via eslint (documentation) and checks for formatting via prettier(documentation) in src.
    • For configs, see prettier.config.js and eslintrc.js.
  • prettier:write : Formats JS and JSON files in src.
    • For configs, see prettier.config.js.

cms-vue-boilerplate's People

Contributors

miketalley avatar tanyascales avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

cms-vue-boilerplate's Issues

Svelte boilerplate

Hi,

I used to do a PR with a svelte version last week.

I'm sorry, think I PR on my own repo, I didn't mean to PR this repo. Thank you to remove it and thank you for your work.

You can find my Svelte boilerplate version here: https://github.com/Hassancxpm/cms-svelte-boilerplate

Please fell free to close this issue.

So sorry 😞 😢

Cannot upload main.js bigger than 1.5MiB

I can't upload a file bigger than 1.5MiB to my dev env in Hubspot.

image

I was trying to split it into chunks but it is not working for this case. Those chunks have to be imported in the HTML. The problem is module.html file, which is an entry point for this module, is generated by HubSpotAutoUploadPlugin and I have no option to change it during built. Do you have any solution for that problem?

main.js file import is hardcoded

I'd like to add hash to the main.js file to prevent it from being cached by browsers. It is very important because I can't force all users of my app to hard refresh the page every time when they want to enter.

How I can accomplish that? The main.js file is imported in the module.html file which is generated by HubSpotAutoUploadPlugin on every build and I have no options to configure it.

Please Update CMS Vue Boilerplate to Vue 3

Can you please update cms-vue-boilerplate to Vue 3? Specifically the main.js targetModulesData, since that seems to have changed quite a bit in Vue 3 and is one of the crucial aspects of connecting an app to HubSpot. Thanks!

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.