MacroStash

Good for...

• Side Projects
• Cron-jobs
• Raspberry Pi event logging

Setting up

How to deploy

1. Fork this Repo.
2. Create a new project on vercel.com (guide)
3. Before deploying, add the environment variables defined in the environment variables section
4. Create a Firestore database and paste the following security rules in the "Rules" tab

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
  	function hasAccount() {
    	return request.auth != null && exists(/databases/$(database)/documents/users/$(request.auth.uid));
    }

    match /{document=**} {
      allow read, write: if false; // other requests are handled by the admin sdk
    }

    match /events/{eventId} {
      allow read: if hasAccount();
    }

    match /projects/{projectId} {
      allow read, write: if hasAccount();
    }

    match /users/{userId} {
      allow read, write: if hasAccount();
    }

     match /pending_users/{userId} {
      allow read: if hasAccount();
    }
  }
}

5. Complete your vercel deployment!
6. Auth Setup
   1. Go to the Authentication tab in your Firebase dashboard and enable Google sign-in provider from the "Sign-in method" tab
   2. In the Authentication Settings page, add your newly deployed vercel project's domain (something.vercel.app) to the "Authorized domains" secion
7. Grab a cookie

Environment Variables

You can find these values from your Firebase Console. Instructions on how to get these values are below.

These values are from your Firebase Config

• PUBLIC_FIREBASE_APIKEY
• PUBLIC_FIREBASE_AUTHDOMAIN
• PUBLIC_FIREBASE_PROJECT_ID
• PUBLIC_FIREBASE_STORAGE_BUCKET
• PUBLIC_FIREBASE_MESSAGE_SENDER_ID
• PUBLIC_FIREBASE_APP_ID

This is from the Firebase Service Account

• FIREBASE_SERVICE_ACCOUNT - Paste your entire Firebase service account json file here

Demo mode

• PUBLIC_DEMO - set this to false

Firebase Setup

• Create a firebase project here. This project will be used to store all of your logs
• Click the "Web" button and fill in the details to register a new web app. Make sure to copy the firebaseConfig object. You will need this later
• Click on the little cog icon next to Project Overview in your Firebase console and go to Project Settings
• Go to the "Service accounts" tab
• Click "Generate new private key"

Logging Events

1. After setting up your MacroStash instance, go to yourdomain.vercel.app/projects and create a new project
2. Open a project to view it's API endpoint
3. Send a POST request to the API endpoint to log events