npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@marklogic-community/grove-vue-template

v1.0.0

Published

Vue template for MarkLogic Grove

Downloads

2

Readme

grove-vue-template

Project template for Grove stack including:

  • grove-ml-gradle (folder marklogic)
  • grove-node (folder middle-tier)
  • grove-vue-ui (folder ui)

Create a Project Based on this Vue Template

Follow the instructions in the Grove Getting Started Guide in order to create a new Grove project.

When asked which UI you prefer, select "Vue". Follow the in-console instructions to configure and run your application.

Developing your project

To install dependencies:

npm install

To create shared configuration between the three tiers (marklogic, middle-tier, and ui):

grove config

To run the tests:

npm test

To start a development server at localhost:3000:

npm start

NOT PREFERRED: Fetching and running this template manually

Manual fetching

Note that preferred way to install this template is using the grove-cli. Follow the instructions in the Grove Getting Starters Guide in order to create a new Grove project using grove-cli.

These are instructions for manually installing this template.

This template currently uses git submodules. You can clone it recursively using:

  • git clone --recurse-submodules https://github.com/marklogic-community/grove-vue-template.git {your-app-name}
  • cd {your-app-name}

This gives you the master branch of the template, and its submodules. Use this to get the development branch instead:

  • git clone -b development --recurse-submodules https://github.com/marklogic-community/grove-vue-template.git {your-app-name}
  • cd {your-app-name}

Consider running the following once if you suspect there are newer commits to the branches, that you'd like to pull in:

  • git submodule update --remote --rebase

It is recommended that you 'eject' from the Grove code repos after cloning this template, meaning you remove the git tracking from your local copy. You can do that with:

  • rm -rf .git .gitmodules */.git

You can then move the contents to a directory that is tracked by a different git project already, or initialize the newly created directory with a new local git repository:

  • git init
  • git add .
  • git commit -m "initial commit"

In case you don't eject, you might want to occasionally check for updates, and merge them with your local setup. You can do so for all submodules using:

  • git submodule update --remote --rebase

It will warn for conflicts with local changes. Append the name of a submodule in case you'd like to run it for just one of them.

Getting the ui started manually

You should use the grove-cli to configure the application by running grove config. Further customization can be done manually in marklogic/gradle{-local}.properties and middle-tier/.env{.local|development|production}.

Run npm install in this directory, which will also run it within the ui and middle-tier directories.

Load sample data:

  • cd marklogic
  • ./gradlew mlDeploy loadSampleData

Run npm start in this directory, which will start the middle-tier and the ui. A browser window should open automatically (at localhost:8080)

Look inside the subfolder READMEs for more detailed instructions.

Further reading

For more background on git submodules, see:

https://git-scm.com/book/en/v2/Git-Tools-Submodules