Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/amercier/nuxt-playground

"Hello World" app built with Nuxt.js + Continuous Integration (Travis) & Deployment (Heroku)
https://github.com/amercier/nuxt-playground

continuous-deployment continuous-integration heroku nuxt travis-ci

Last synced: 18 days ago
JSON representation

"Hello World" app built with Nuxt.js + Continuous Integration (Travis) & Deployment (Heroku)

Awesome Lists containing this project

README

        

nuxt-playground
===============

> *Hello World* app built with Nuxt [Nuxt], with:
> - **Continuous Integration** with Travis CI [Travis CI], running:
> - JavaScript linting with ESLint [ESLint]
> - Unit testing with Jest [Jest] (including snapshots)
> - End-to-end testing with Ava [Ava]
> - **Continuous Deployment** with Heroku [Heroku]

[![Build Status](https://travis-ci.org/amercier/nuxt-playground.svg?branch=master)](https://travis-ci.org/amercier/nuxt-playground)
[![Test Coverage](https://img.shields.io/codecov/c/github/amercier/nuxt-playground/master.svg)](https://codecov.io/github/amercier/nuxt-playground?branch=master)

[▶ Live Demo](https://nuxt-playground.herokuapp.com/)

Prerequisites
-------------

- [Node.js] 8+, with **NPM** 5+

Getting started
---------------

### 1. Install

```sh
npm install
```

### 2. Start application

```sh
npm run dev
```

Open

### 3. Run tests

```sh
npm run test
```

**Note:** this runs `npm run test:unit` (unit tests) and `npm run test:e2e` (end-to-end tests) in parallel, see [package.json] for details.

Deployment
----------

### Heroku

1. Create a new Heroku app
2. Set config vars:
- `HOST` = `0.0.0.0`
- `NODE_ENV` = `production`
3. Deploy your app (`git push heroku master` if you are [deploying with Git](https://devcenter.heroku.com/articles/git))

Read [How to deploy with Heroku?](https://nuxtjs.org/faq/heroku-deployment) for more details. (note: `NPM_CONFIG_PRODUCTION` is not required for this app as we use `dependencies` instead of `devDependencies`).

### Others

Please refer to official [Nuxt FAQ]:
- [How to deploy with Now?](https://nuxtjs.org/faq/now-deployment)
- [How to deploy with Dokku?](https://nuxtjs.org/faq/dokku-deployment)
- [How to deploy with Surge?](https://nuxtjs.org/faq/surge-deployment)
- [How to deploy with Github?](https://nuxtjs.org/faq/github-pages)

License
-------

[![License](https://img.shields.io/github/license/amercier/nuxt-playground.svg)](./LICENSE.md)

[Nuxt]: https://nuxtjs.org/
[Nuxt FAQ]: https://nuxtjs.org/faq/
[Travis CI]: https://travis-ci.org/
[ESLint]: https://eslint.org/
[Jest]: https://facebook.github.io/jest/
[Ava]: https://ava.li/
[Heroku]: https://www.heroku.com/
[Node.js]: https://nodejs.org/en/
[package.json]: [./package.json]