Skip to content

alvinwhite/ns_boilerplate

Repository files navigation

Getting started

Open command line in the proejct directory and run npm install

Then run npm run dev to start a developemnt server

You also can use yarn instead of npm obviously ;)

Other commands

package.json scripts are used to execute commands, to run one you should type yarn run {command name}

Comamnd name Description
dev Starts developing server
prod Builds production version
create::component {component name} Creates empty component in components directory with Pug, Stylus and JavaScript files
create::page {component name} Creates page in pages directory with the same files as for a component

Notes

  • All pages are included as Webpack entries automatically, directory name of the page should be the same as page name
  • When importing files, you can use Webpack aliases option to avoid having ugly paths https://webpack.js.org/configuration/resolve/#resolve-alias Existing alieses are Components and @ (see examples in src/pages/index), .js and .styl both support aliases.

About

A boilerplate for creating new projects

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published