Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/clarkdo/hare

🐇 Application boilerplate based on Vue.js 2.x, Koa 2.x, Element-UI and Nuxt.js
https://github.com/clarkdo/hare

ava babel element-ui javascript koa2 nodejs nuxtjs scaffold vue2 web yarn

Last synced: 1 day ago
JSON representation

🐇 Application boilerplate based on Vue.js 2.x, Koa 2.x, Element-UI and Nuxt.js

Host: GitHub
URL: https://github.com/clarkdo/hare
Owner: clarkdo
License: other
Created: 2017-03-30T04:02:28.000Z (over 7 years ago)
Default Branch: dev
Last Pushed: 2024-11-18T16:18:28.000Z (about 1 month ago)
Last Synced: 2024-12-15T23:03:05.153Z (8 days ago)
Topics: ava, babel, element-ui, javascript, koa2, nodejs, nuxtjs, scaffold, vue2, web, yarn
Language: Vue
Homepage: https://nuxt-hare.herokuapp.com
Size: 3.7 MB
Stars: 256
Watchers: 9
Forks: 53
Open Issues: 44
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # ![Logo](http://clarkdo.github.io/public/img/hare-logo-blue.svg) Application boilerplate based on Vue.js 2.x, Koa 2.x, Element-UI and Nuxt.js

[![CircleCI](https://circleci.com/gh/clarkdo/hare.svg?style=svg)](https://circleci.com/gh/clarkdo/hare)

[![Windows](https://ci.appveyor.com/api/projects/status/16eua6xnlnwxqomp?svg=true)](https://ci.appveyor.com/project/clarkdo/hare)

[![Vulnerabilities](https://snyk.io/test/github/clarkdo/hare/badge.svg)](https://snyk.io/test/github/clarkdo/hare)

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

[![ESLint](https://img.shields.io/badge/styled_with-eslint-blue.svg?colorB=8080f2)](https://github.com/eslint/eslint)

[![Issues](https://img.shields.io/github/issues/clarkdo/hare.svg)](https://github.com/clarkdo/hare/issues)

[![Stars](https://img.shields.io/github/stars/clarkdo/hare.svg)](https://github.com/clarkdo/hare/stargazers)

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/clarkdo/hare/master/LICENSE)

## Installation

``` bash

$ git clone [email protected]:clarkdo/hare.git

$ cd hare

# install dependencies

$ yarn

```

## Usage

### Development

``` bash

# serve with hot reloading at localhost:3000

$ yarn dev

```

Go to [http://localhost:3000](http://localhost:3000)

### Testing

``` bash

# configure ESLint as a tool to keep codes clean

$ yarn lint

# use ava as testing framework, mixed with jsdom

$ yarn test

```

### Production

``` bash

# build for production and launch the server

$ yarn build

$ yarn start

```

### Generate

``` bash

# generate a static project

$ yarn generate

```

### Analyze

``` bash

# build and launch the bundle analyze

$ yarn analyze

```

### Use PM

#### Further more features refer: [PM2](https://github.com/Unitech/pm2)

``` bash

# install pm2 globally

$ yarn global add pm2

# launch development server

$ yarn dev:pm2

# launch production server

$ yarn start:pm2

# Display all processes status

$ pm2 ls

# Show all information about app

$ pm2 show hare

# Display memory and cpu usage of each app

$ pm2 monit

# Display logs

$ pm2 logs

# Stop

$ pm2 stop hare

# Kill and delete

$ pm2 delete hare

```

### Docker Dev

``` bash

# build image

$ docker build -t hare-dev -f Dockerfile.dev ./

$ docker run -d -p 8888:3000 -e HOST=0.0.0.0 hare-dev

```

Go to [http://localhost:8888](http://locdoalhost:8888)

### Docker Production

``` bash

# build bundle

$ export NODE_ENV=''

$ yarn

$ yarn build

# install production dependencies (remove devDependencies)

$ yarn --prod

# build image

$ docker build -t hare-prod -f Dockerfile ./

$ docker run -d -p 8889:3000 -e HOST=0.0.0.0 hare-prod

```

Go to [http://localhost:8889](http://locdoalhost:8889)

## Documentation

Vue.js documentation: [https://vuejs.org/](https://vuejs.org/)

Nuxt.js documentation: [https://nuxtjs.org](https://nuxtjs.org)

Element-UI documentation: [http://element.eleme.io](http://element.eleme.io/#/en-US)

Koa documentation: [https://github.com/koajs/koa](https://github.com/koajs/koa)