README.md

cacioepepe

BostonHacks Registration Portal

Project setup

npm install

Compiles and hot-reloads for development

npm run serve

Compiles and minifies for production

npm run build

Testing Build

serve -s dist OR firebase serve --only hosting

Lints and fixes files

npm run lint

Customize configuration

See Configuration Reference.

Calling Firebase functions

With an authenticated @firebase/app object,

import { functions } from "../firebase/init";
firebase.functions().httpsCallable("name-of-function")(input_data).then(data => {...})

For more info on the types of functions, visit the official Firebase Documentation.

Making a Firestore transaction

With an authenticated @firebase/app object,

import { db } from "../firebase/init";
db.collection("name-of-collection").doc("doc-identifier").action().then(data => {...})

For more info on actions that can be performed, visit the official Firebase Documentation.

Deploying Firebase Resources

Run the following command after installing the Firebase CLI to deploy everything but the website.

firebase deploy --except hosting

To deploy functions,

npm run deploy

To deploy a specific function,

firebase deploy --only functions:(function name)

Deploying the Website to Staging

After running the buildscript, run the following command.

firebase deploy --only hosting:staging

Deploying the Website to Production

After running the buildscript, run the following command.

firebase deploy --only hosting:production

Contributing

To contribute to Cacioepepe, view our contribution guide.