Getting started with the Vue.js starter project

Prismic makes it easy to get started on a new Vue.js project by providing a Vue.js starter project.

Clone the Prismic Vue.js starter

First step is to clone the Prismic Vue.js starter in your local environment. Open a terminal (command prompt or similar on Windows) and run the following command:

Copy
git clone https://github.com/prismicio/vuejs-starter

Or if you prefer you can directly download it as a ZIP archive.

Install the depencencies

Next, navigate to the root directory of the Vue.js starter in your local environment and run the following command:

Copy
npm install

Launching your local server

Then you can launch your local server, for that run the following command:

Copy
npm run dev

You can now open your browser to http://localhost:8080. You should see a tutorial page explaining how to create a Vue component with content managed in Prismic.

And your Prismic journey begins!

Now you're all set to start building your Vue.js project with Prismic content management. Here are the next steps you need to take.

Create a Prismic repository

If you haven't already the first step is to create a repository. A repository is where your website's content will live. Simply create one choosing a repository name and a plan. We've got a variety of plans including our favorite, Free!

Define your Custom Types

Next you'll need to model your pages, posts, events, etc. into your Custom Types. You can refer to our user guides to learn more about constructing your Custom Types thanks to our easy drag-n-drop builder.

Query your documents

After you've created and published some documents in your Prismic repository, you'll be able to query the API to retrieve your content. We provide explanations and plenty of examples of queries in the Query the API section of the documentation. Start by learning more on the How to Query the API page.

Integrate content into your templates

The last step is to integrate the content into your templates. Check out the Templating section of the documentation to learn more.