Dev Environment Setup

Github

We use Github for source control. You need access to our Git Organization in order to contribute code. To get access, message James in Slack with your Github username and he will add you.

The honeygrid repository contains the bulk of the HoneyGrid code including the Web App, the REST API and associated microservices, and the dev docs site.

For more information on the contents of the repo refer to HoneyGrid Architecture.

HoneyGrid Repo

The HoneyGrid repo is a PNPM Workspace monorepo. If you don’t already have it installed, we recommend installing it via npm.

After installing pnpm install your dependencies.

# Run at the project root to install dependencies for all sub apps
pnpm install

Project structure

The HoneyGrid monorepo is organized into two main directories:

honeygrid/
├── apps/                 # Deployable applications
│   ├── api/              # Main REST API worker
│   ├── web-app/          # React web application
│   ├── google-oauth/     # Cloudflare worker containing Google Oauth callback
│   └── dev-docs/         # Documentation site (this site)
│
└── packages/             # Shared code used across apps
    └── honeygrid-types/  # TypeScript type definitions, zod validators, drizzle schemas

Cloudflare

HoneyGrid is built on Cloudflare Workers, a globally-distributed serverless platform built on Cloudflare’s network with built-in bindings for service-to-service communication (Service Bindings) data storage (KV, Durable Objects, Queues), asset storage (R2), durable execution (Workflows), AI, Secrets and more.

Why Cloudflare

If you are familiar with other serverless cloud providers like AWS Lambda, Google Cloud Functions, or Azure Serverless Functions, then Cloudflare Workers will feel similar. It maintains the same benefits like,

• Zero server management: no need to provision, patch, or maintain servers
• Automatic scaling: infrastructure scales automatically with demand
• Scale to zero: only pay for actual compute time used
• High availability: built-in redundancy and fault tolerance across multiple regions
• Built-in security: platform handles security patches and infrastructure hardening
• Reduced operational overhead: no need for capacity planning or load balancing
• Focus on code: developers can focus purely on business logic

Workers has some unique benefits that make it particularly attractive such as,

• Global Cloudflare network: most serverless platforms require you to select availability regions where your cloud functions will be hosted. Anyone far from those locations will see increased latency in their requests. Cloudflare automatically runs our functions in all of their 300+ data centers worldwide
• No cold starts: One of the biggest downsides to serverless is “cold starts” where requests incur a noticeable delay after a period of inactivity. Workers uses a technology called Isolates that eliminates this problem
• Free CDN: Hosting the static assets for our application is free and globally distributed for the fastest load times possible
• Lower cost: Cloudflare does not charge for data egress, offers generous free tiers for nearly all products, and charges less for base compute than any other major provider. Check out the impact migrating from AWS to Cloudflare had for Baselime, a popular observability platform.

Getting access

You can access our acount via the Cloudflare Dashboard. If you do not have access yet message James in Slack with your preferred email address and he will add you.

Cursor

Cursor is an AI-powered code generation tool that helps developers write, refactor, and understand code more efficiently. It leverages AI models to provide context-aware code suggestions, automate repetitive tasks, and improve overall code quality.

Why We Use Cursor at HoneyGrid

At HoneyGrid, we use Cursor as our default code editor because in our experience it provides the best AI integration of all major editors.

Check out Cursor Editor for setup instructions and Cursor Rules for the default rule set we recommend.

Once you have downloaded Cursor, James can help you set up your subscription.