Installation
Prerequisites
Install the following before you begin:
Access Required
Before cloning the repo, make sure you have:
- A company email address
- Access to the Google organization account
- Git access to the repository
If you're missing any of the above, ask your team lead.
Getting Started
1. Clone the repository
Clone the latest branch:
git clone --branch latest <repository-url>
2. Add your environment file
You need a .env file with database credentials and secrets. Request one from your team.
3. Install dependencies
pnpm i
warning
If there's no pnpm-lock.yaml, ask a colleague for the lockfile before running install.
4. Start the dev server
pnpm dev
Starts on localhost:3010 (HTTP) and :31225 (WebSocket).
Git Workflow
- Create a new branch from
latest:git checkout latestgit checkout -b your-branch-name - Make your changes and push.
- Open a Pull Request targeting the
latestbranch.
info
Never push directly to latest. All changes go through a PR.
Environment Configuration
| Config Type | Source | Notes |
|---|---|---|
| Local env vars | .env file | Do not commit secrets |
| Global configs | @logic-bee/config → globalFlags | Feature toggles |
| Secrets | @logic-bee/config → globalSecrets | Encrypted credentials |
Recommended Tools
| Tool | Purpose | Link |
|---|---|---|
| WebStorm | Primary IDE | jetbrains.com/webstorm |
| Antigravity IDE | AI-assisted development | antigravity.google/download |
| MongoDB Compass | Visual database browser | mongodb.com/compass |
Communication Tools
| Tool | Purpose | Link |
|---|---|---|
| Slack | Team messaging | slack.com |
| Zoom | Video calls | zoom.us |