hoy-slices v0.5.0

sms-hoy

HOY with Slice Machine

Live here

About

This website is made with Vue.js under Nuxt.js, for detailed explanation on how things work please refer to related documentations.

Setup

Prerequisites

None~

Install

After having the project cloned just install node dependencies:

# install dependencies with yarn
$ yarn install
# or with npm
$ npm install

During the process you can also create a .env file by copying .env.example and fill it with needed environment variables.

Please note that the .env file also allow you to customize basic settings of the application though it's highly recommended to provide those value through a CMS

Development

Start server without Netlify functions:

To run the project without Netlify functions simply run:

# launch nuxt development server with yarn
$ yarn dev
# or with npm
$ npm run dev

Nuxt development server will be running at localhost:3000

Plop

Plop is configured on this project to generate regular components as well as pages and layouts one.

To use Plop you need its CLI installed globally, if you don't have it already you can install it this way:

# install plop globally with yarn
$ yarn global add plop
# or with npm
$ npm install --global plop

Then the plop command will guide you through creating desired components.

Build

To build the project simply run:

# generate static project with yarn
$ yarn build && yarn export
# or with npm
$ npm run build && npm run export

You'll end up with the built site available at ./dist