Harmoni

Before you start, make sure you have the latest node.js version installed. To run the firebase commands you need to have firebase installed globally, this can be done with:

npm install -g firebase-tools
npm install nodemon -g
firebase login 

or if you don't have access to the firebase project, or don't wish to use firebase:

npm install nodemon -g

with this option you can only use the nodemon and npm method for running server/client respectively.

IMPORTANT: The server will not work without the documents mentioned below!

You need the properties.js file to connect to the database, and the fbcredential.json file to use fileupload functionality. Both of these go under the functions folder.

Alternativly, you can connect you own google cloud credentials by generating a service account for Cloud Storage, and pasting the contents in the given file into another, named fbcredential.json. If this is the case, the bucket where you store your public images needs to set to public.

run client and server with firebase

From the top repository (npm install must have been run in both functions and public), here the react app has to be built first, disabling hot reloads.

cd public
npm run-script build && firebase serve 

run server with hot reloads through nodemon

From the top repository, hot reloads are built in here. This local server runs under the endpoint http://localhost:8080

cd functions
npm install && nodemon index.js

run client alone with hot reloads through npm

From the top repository

cd public
npm install && npm start

run firebase server alone

From the top repository, hot reloads are built in here. The local server runs under the endpoint http://localhost:5001/harmoni-6/us-central1/webApi/api/v1/ while the deployed endpoint runs under https://us-central1-harmoni-6.cloudfunctions.net/webApi/api/v1/

cd functions
npm install && firebase serve --only functions

deploy

To publish to the internet your google user has to be added to the following firebase project: https://console.firebase.google.com/u/1/project/harmoni-6/hosting/main and you have to be signed in as this user locally. If these requirements are satisfied you can run the following commands from the top level repository:

firebase deploy