https://github.com/nypublicradio/gothamist-vue

Code owner: @kimlarocca
https://github.com/nypublicradio/gothamist-vue

gothamist nuxt nuxtjs vue vuejs

Last synced: 18 days ago
JSON representation

Code owner: @kimlarocca

• Host: GitHub
• URL: https://github.com/nypublicradio/gothamist-vue
• Owner: nypublicradio
• Created: 2021-01-04T17:43:42.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2022-10-03T20:02:51.000Z (over 2 years ago)
• Last Synced: 2024-04-10T20:53:18.467Z (9 months ago)
• Topics: gothamist, nuxt, nuxtjs, vue, vuejs
• Language: Vue
• Homepage: https://gothamist.com
• Size: 7.27 MB
• Stars: 1
• Watchers: 16
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# gothamist-vue

## Build Setup

```bash

# install dependencies

$ npm install

# copy .env file

$ cp .env.sample .env

# serve with hot reload at localhost:3000

# note: use http://localhost:3000 (not the IP address Nuxt provides) or else Disqus will not work properly

$ npm run dev

# build for production and launch server

$ npm run build

$ npm run start

# generate static project

$ npm run generate

```

For detailed explanation on how things work, check out [Nuxt.js docs](https://nuxtjs.org).

## Running in Docker

To run this app in a production-like setup, use docker.

The basic dev container can be run with the following commands:

```bash

docker build . -t gothamist-vue:latest

docker run -it -p 3000:3000 -e ENV=dev gothamist-vue

```

If you'd like to run the app behind nginx, instead change the ENV variable

```bash

docker run -it -p 80:80 -e ENV=demo gothamist-vue

```

## Deployment

For SSR, this app uses Nuxt. Nuxt runs within a Docker container deployed to our fastboot-  ECS clusters. The deployment consists of two parts, the static files which are deployed to S3 [using gulp](https://nuxtjs.org/faq/deployment-aws-s3-cloudfront/), and the Nuxt docker container which is deployed using [nyprsetuptools](https://github.com/nypublicradio/nyprsetuptools). The following env vars are needed for the deployment to succeed.

 

| Variable              | Description                                  |

| --------------------- | -------------------------------------------- |

| NUXT_HOST             | Primary host at which Nuxt will be accessed. |

| NUXT_PORT             | Port used by Nuxt.                           |

| AWS_ACCESS_KEY_ID     | Needed by circleci to deploy.                |

| AWS_SECRET_ACCESS_KEY | Needed by circleci to deploy.                |

| AWS_BUCKET_NAME       | The S3 bucket to deploy static files to.     |

| AWS_CLOUDFRONT        | The ID of the cloudfront distribution fronting the app. |

### Notes

Set the theme in the assets/main.scss file

Having issues with PostCSS or NodeSass? npm rebuild node-sass