https://github.com/ali322/ssr-boilerplate

ssr frontend project boilerplate
https://github.com/ali322/ssr-boilerplate

koa nva ssr vue vue-router vuex webpack

Last synced: about 2 months ago
JSON representation

ssr frontend project boilerplate

• Host: GitHub
• URL: https://github.com/ali322/ssr-boilerplate
• Owner: ali322
• Created: 2017-11-29T08:09:31.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2020-11-10T06:30:12.000Z (about 4 years ago)
• Last Synced: 2024-11-03T08:24:05.334Z (3 months ago)
• Topics: koa, nva, ssr, vue, vue-router, vuex, webpack
• Language: JavaScript
• Homepage:
• Size: 373 KB
• Stars: 3
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# SSR Boilerplate

[![Build Status](https://travis-ci.org/ali322/ssr-boilerplate.svg?branch=master)](https://travis-ci.org/ali322/ssr-boilerplate)

[![Dependency Status](https://gemnasium.com/badges/github.com/ali322/ssr-boilerplate.svg)](https://gemnasium.com/github.com/ali322/ssr-boilerplate)

[![Maintainability](https://api.codeclimate.com/v1/badges/ba09b7efe52888308abc/maintainability)](https://codeclimate.com/github/ali322/ssr-boilerplate/maintainability)

ssr(server side render) project boilerplate [中文文档](./README_zh.md)

Develop

===

1. clone to your local disk `git clone https://github.com/ali322/ssr-boilerplate`

2. run `npm install`

3. run `npm install nva -g`

5. run `nva dev` to start develop server

6. run `npm run lint` to lint source code

7. run `npm test` to run tests

Deploy

===

1. run `nva build` release static source and inject to html

2. upload your project to deploy environment

1. run `npm install --production`

2. run `npm install pm2 -g` (more instructions in [pm2 documention](https://github.com/Unitech/PM2))

3. run `pm2 start app.js --name ` to deploy

Directory structure

===

```sh

test/

    |-- client/ #client unit tests

    |-- server/ #server unit tests

client/

    |-- asset/      #images,fonts and so on

    |-- bundle/

        |-- common/ #public css and js

        |-- component/ #component's css

        |-- error/  #error page's entry js and css

        |-- index/  #index page's entry js and css

        |-- .../    #more your own page's entry js and css,like index page

    |-- dist/     #compiled client assets

server/

    |-- controller/ #express routes directory

    |-- lib/        #server libraries,util and helper modules inside

    |-- router.js   #server router,all the routes is defined here

    |-- bootstrap.js #initialize application,load middlewares and setup

    |-- view/

        |-- layout.html #global layout template

        |-- index.html  #index page's template

        |-- *.html      #more your own page's template

app.js      #web application enrty file

```

## License

[MIT License](http://en.wikipedia.org/wiki/MIT_License)