search

nwplus / nwhacks2019

⛰ The official website, registration, and check-in system for nwHacks 2019
https://2019.nwhacks.io
Other
12 stars 3 forks source link

readme

nwHacks 2019 ⛰

The website, registration, and check-in system for nwHacks 2019

Build Status


:construction: Development

$> git clone https://github.com/nwplus/nwhacks2019.git
$> cd nwhacks2019 ; make
$> cp .example.env .env
$> vi .env # fill out environment variables

Web App

The front-end is a React web app.

$> make web         # Serve web app using webpack-dev-server
$> make test        # To run the web app tests locally
$> make lint        # To run the linter locally
$> make build       # To build the web app into `./docs`
$> make serve       # Serve built static web app

Functions

The back-end is powered by serverless functions deployed to Firebase.

$> make functions   # Deploy functions locally
$> make shell       # Start an interactive shell for functions

# Deployment
$> make deploy-dev
$> make deploy-prod

Running the entire app

For development: To serve the web app locally and emulate the cloud functions locally, use make dev. For production: To build the web app and publish the cloud functions to production, use make prod.