Krow/Krow-workspace
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(docs): update contributing guide with required tools and IDE setup

Browse Source 
feat(internal/launchpad): add iframe viewer for prototypes and update links loader

This commit introduces an iframe viewer in the launchpad to display prototypes directly within the application. It also updates the links loader to handle prototype links differently, opening them in the iframe instead of a new tab.

The contributing guide has been updated to include a list of required development tools and recommended IDE setup, ensuring that contributors have the necessary tools to work on the project.
This commit is contained in:
bwnyasse
2026-01-10 23:48:45 -05:00
parent 5dca852aab
commit ea6765af96
3 changed files with 66 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/03-contributing.md
View File

@@ -23,9 +23,26 @@ Follow these steps to set up your development environment and gain access to all
* Install Enpass (our team's shared password manager).
* Ensure you have access to the shared KROW vault for all project credentials (API keys, service accounts, etc.).
5. **Install Recommended Development Tools:**
* **IDE:** We recommend **VS Code** or **Vim/Neovim** for development.
* **Diagramming:** Use **MermaidChart.com** for creating and editing diagrams (Mermaid syntax).
5. **Install Required Development Tools:**
Before running the project, ensure you have the following installed:
* **Node.js (v20+):** We recommend using **[nvm](https://github.com/nvm-sh/nvm)** (Node Version Manager) to install and manage Node versions.
* **pnpm:** Our preferred package manager for JavaScript projects. (`npm install -g pnpm`)
* **Flutter Version Management (FVM):** We use **[FVM](https://fvm.app/)** to manage Flutter SDK versions per project. Install it via Homebrew (`brew install fvm`) or Dart (`dart pub global activate fvm`).
* **Firebase CLI:** Required for emulation and deployment. (`npm install -g firebase-tools`)
* **Google Cloud CLI (gcloud):** Required for backend authentication and resource management.
**Recommended IDE:**
* **[Google Project IDX (Antigravity)](https://idx.google.com/)** or **VS Code**.
* **Essential Extensions:**
* Flutter & Dart
* Firebase
* Tailwind CSS IntelliSense
* ESLint & Prettier
**Diagramming:**
* Use **MermaidChart.com** for creating and editing diagrams (Mermaid syntax).
6. **Local Development Environment Setup:**
* Clone the monorepo: `git clone git@github.com:Oloodi/krow-workforce.git`