Skip to content

opendream/rumors-site

 
 

Repository files navigation

rumors-site

Build Status Coverage Status

Rumors list / creation UI, with server-side rendering.

Configuration

For development, copy .env.sample to .env and make necessary changes.

For production via rumors-deploy, do setups in docker-compose.yml.

Development

This project uses NodeJS 8+ and npm 5+.

$ npm install
$ npm run dev # Then visit http://localhost:3000

# Before you pull request, please lint your code first
$ npm run lint
# fix eslint
$ npm run lint:fix
# run test
$ npm t

styled-jsx syntax highlighting

See: https://github.com/zeit/styled-jsx#syntax-highlighting

Landing Page (Makeshift)

We build a temporary landing page in the repo grants-landing-template.

When the landing page repo is in the same directory of this repo, run the command below to update the landing page in this repo:

grants-landing-template $ npm start
# After the landing page is compiled, ctrl-c

grants-landing-template $ cd ../rumors-site

rumors-site $ npm run landing

Deploy

Build docker image. These images are the same, just tagged differently.

# Production build
$ npm run build

# Staging build
$ npm run build:staging

Run the docker image on local machine, then visit http://localhost:3000.

$ docker run --rm -p 3000:3000 -e "PORT=3000" mrorz/rumors-site

Push to dockerhub

# Production
$ docker push mrorz/rumors-site:latest

# Staging
$ docker push mrorz/rumors-site:staging

Design and Mockups

About

Rumors list / creation UI, with server-side rendering

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 84.4%
  • HTML 12.6%
  • CSS 2.8%
  • Dockerfile 0.2%