Official involveMINT Web App Repository

Build Prerequisites

Prerequisites:

• Node.js
• Docker

Steps to Set Up Environment

1. Fork and clone this repository. Ensure that you uncheck the "copy main branch only" checkbox. Once you forked the repository, clone it to a directory on your local machine and cd into it.

2. Checkout the "develop" branch: git checkout develop.

3. Ensure you have Node.js installed. If you don't, please look at the section on installing node.js.

4. Ensure you have Docker installed. If you don't, please navigate to the official website and follow the instructions. Run docker --version in your terminal after it's installed to ensure you have installed everything correctly.

Installing Node.js

Run the following commands.

1. curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
2. export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")"
3. [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
4. Refresh your shell (close and reopen). If you're using zsh, here's a shortcut: source ~/.zshrc
5. If the following command does not throw an error, you're good so far: nvm -v
6. nvm install lts/gallium
7. nvm use lts/gallium

Configuring Firebase

In order to run this code, you will need to navigate to firebase. You will see a screen that looks like and click "Create a project" (if you don't already have a GCP account and an existing project where you want to use Firebase). Once you have a project, you should see a screen like Once here, click the little gear and you'll see a screen that looks like Select the "Service accounts" tab and you'll see a screen that looks like Hit the "Manage service account permissions" hyperlink which will take you to your GCP project. You will see a screen that looks like . Click the account and then hit the "Keys" tab. You should see a screen that looks like . Click "Add Key" and then choose the "JSON" option to download it as a JSON file.

Ensure you are in the project directory (the directory that this file is in). Run the following command: cp libs/shared/domain/src/lib/environments/environment.ts libs/shared/domain/src/lib/environments/environment.local.ts and open the new file (environment.prod.ts) in your editor. It should look like this at first:

import { Env } from './environment.interface';

const host = 'localhost';

/** Develop environment variables. */
export const environment: Env = {
  production: false,
  test: false,
  host,
  apiUrl: `http://${host}:3335`,
  appUrl: `http://${host}:4202`,
  storageBucket: 'your storage bucket',
  adminPasswordHash:
    'sZfCJx5X3sGSwkokIs9IVFxDfxWd2lEKsAhkOSDfEK8u2YS98y5rJAmXmtrJs7AQ29xkHMmz0bDfLkXCKS9/+A==',
  gcpApiKey: 'insert your key here',
  typeOrmConfig: {
    type: 'postgres',
    host: '127.0.0.1',
    port: 5433,
    username: 'postgres',
    password: '1Qazxsw2',
    database: 'involvemint',
    synchronize: true,
    autoLoadEntities: true,
    ssl: false,
  },
  firebaseEnv: {
    apiKey: 'insert your key here',
    authDomain: 'firebase auth domain',
    databaseURL: '',
    projectId: 'your project id',
    storageBucket: 'Your project storage bucket', //your-something.appspot.com
    messagingSenderId: '',
    appId: 'your app id',
    measurementId: 'Your measurementId',
  },
  // mailgun and twilio are optional
  mailgun: {
    apiKey: '',
    domain: '',
  },
  twilio: {
    accountSid: '',
    authToken: '',
    sendingPhone: '',
  },
  gcp: {
    type: 'service_account',
    project_id: 'project-id',
    private_key_id: 'Your Private Key',
    private_key: '-----BEGIN PRIVATE KEY-----\nYour Private Key\n-----END PRIVATE KEY-----\n',
    client_email: 'Your client email',
    client_id: 'client id',
    auth_uri: 'https://accounts.google.com/o/oauth2/auth',
    token_uri: 'https://oauth2.googleapis.com/token',
    auth_provider_x509_cert_url: 'https://www.googleapis.com/oauth2/v1/certs',
    client_x509_cert_url: 'cert url',
  },
  // I don't think this is used
  scrypt: {
    memCost: 14,
    rounds: 8,
    saltSeparator: 'Bw==',
    signerKey: 'de/PQ/Gy53mgslvUgDUKDCgHJPArYqbFnGILLQZNe5My/CvqIThVL/CsndU8oudZ9lc4B7PT8w3sAar2/luQxA==',
  },
  defaultLocalAddress: [{
    streetNumber: '5000',
    streetName: 'Forbes Ave',
    formattedAddress: '5000 Forbes Ave, Pittsburgh, PA 15213',
    city: 'Pittsburgh',
    administrativeLevels: {
      level1short: 'PA'
    },
    zipcode: '15213',
    latitude: 40.444229,
    longitude: -79.943367
  }]
};

Under the key "typeOrmConfig", please change the password field to "postgres". Under the key "gcp", please change the fields to match the fields in your service account JSON file that you just downloaded in the previous step.

Starting the Containers

Run docker compose up in the root directory, which will spin up a PostgreSQL database on port 5433, a PgAdmin UI on port 8889, and a firestore emulator available at http://127.0.0.1:4000.

If you are prompted for the pasword (below screenshot) when opening PgAdmin at http://localhost:8889 enter postgres.

Starting the Apps

• Open a terminal and run npm i from root directory to install all the required packages.
• Run export FIREBASE_STORAGE_EMULATOR_HOST=localhost:9199.
• Run export FIRESTORE_EMULATOR_HOST='localhost:8080'.
• Run npm run start:client:local which will start the client app.
• Leave that terminal open and running and open a new terminal
• In the new terminal: Run export FIREBASE_STORAGE_EMULATOR_HOST=localhost:9199.
• In the new terminal: Run export FIRESTORE_EMULATOR_HOST='localhost:8080'.
• Then Run npm run start:server:local which will start the server app.

Once running, the client can be accessed via http://localhost:4202 and the api/server will be running on http://127.0.0.1:3335

For any issues, or to suggest improvements to this documentation, please contact Anish Sinha <[email protected]>