From b7e67ba293260643a33b85aff3da4cc39e79c037 Mon Sep 17 00:00:00 2001 From: Randall Morey Date: Wed, 12 Jul 2023 13:53:39 -0700 Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20add=20list=20of=20?= =?UTF-8?q?recommended=20tooling=20(#1747)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: ✏️ add list of recommended tooling * Update README.md Co-authored-by: Dharini Jeeva * Update README.md Co-authored-by: Dharini Jeeva --------- Co-authored-by: Dharini Jeeva Co-authored-by: Carlos Alcaide Corvo --- README.md | 78 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 48 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 8bcaf6b15..bacec82a4 100644 --- a/README.md +++ b/README.md @@ -13,30 +13,29 @@ subproject, e.g. running or testing. -**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* -- [Boundary UI Monorepo](#boundary-ui-monorepo) - - [Projects](#projects) - - [Core (addons/core):](#core-addonscore) - - [API (addons/api):](#api-addonsapi) - - [Auth (addons/auth):](#auth-addonsauth) - - [Rose (addons/rose)](#rose-addonsrose) - - [Admin (ui/admin)](#admin-uiadmin) - - [Desktop Client (ui/desktop)](#desktop-client-uidesktop) - - [Prerequisites](#prerequisites) - - [Installation](#installation) - - [Yarn Commands](#yarn-commands) - - [Contributing](#contributing) - - [Branching](#branching) - - [Building ToC](#building-toc) - - [Building Admin UI for Production](#building-admin-ui-for-production) - - [Building with a Container](#building-with-a-container) - - [Building Desktop UI for Production](#building-desktop-ui-for-production) - - [Connect Boundary UI to Boundary local instance](#connect-boundary-ui-to-boundary-local-instance) - - [For admin](#for-admin) - - [For desktop](#for-desktop) - - [Committing](#committing) - - [License Checking](#license-checking) +- [Projects](#projects) + - [Core (addons/core):](#core-addonscore) + - [API (addons/api):](#api-addonsapi) + - [Auth (addons/auth):](#auth-addonsauth) + - [Rose (addons/rose)](#rose-addonsrose) + - [Admin (ui/admin)](#admin-uiadmin) + - [Desktop Client (ui/desktop)](#desktop-client-uidesktop) +- [Prerequisites](#prerequisites) +- [Optional Tooling](#optional-tooling) +- [Installation](#installation) +- [Yarn Commands](#yarn-commands) +- [Contributing](#contributing) + - [Branching](#branching) + - [Building ToC](#building-toc) + - [Building Admin UI for Production](#building-admin-ui-for-production) + - [Building with a Container](#building-with-a-container) + - [Building Desktop UI for Production](#building-desktop-ui-for-production) + - [Connect Boundary UI to Boundary local instance](#connect-boundary-ui-to-boundary-local-instance) + - [For admin](#for-admin) + - [For desktop](#for-desktop) + - [Committing](#committing) + - [License Checking](#license-checking) @@ -74,12 +73,19 @@ You will need the following things properly installed on your computer. * [Google Chrome][chrome] * [Firefox][firefox] -[git]: https://git-scm.com/ -[node]: https://nodejs.org/ -[yarn]: https://classic.yarnpkg.com/lang/en/ -[chrome]: https://google.com/chrome/ -[firefox]: https://firefox.com/ -[yarn-workspaces]: https://classic.yarnpkg.com/en/docs/workspaces/ + +## Optional Tooling + +Our team finds the following applications useful in day-to-day development +workflows. These are merely recommendations. We encourage you to use the tools +that best suit you and your personal style. + +* [VS Code][vscode]: Code editor for building and debugging web applications +* [Warp][warp]: Terminal application for macOS +* [Homebrew][homebrew]: The missing package manager for macOS and Linux +* [Ember Inspector][ember-inspector]: Understand and debug Ember applications +* [Postman][postman]: Test and inspect APIs + ## Installation @@ -154,7 +160,7 @@ In windows, UI is generated using docker to provide a stable UI across platforms ```cmd yarn install -docker-compose -f docker-compose-embedding.yml run build-desktop-production +docker-compose -f docker-compose-embedding.yml run build-desktop-production yarn build:ui:desktop:app ``` @@ -209,3 +215,15 @@ The change will be verified upon PR. GPL variants and UNLICENSED dependencies will not be accepted. [github-flow]: https://guides.github.com/introduction/flow/ + +[git]: https://git-scm.com/ +[node]: https://nodejs.org/ +[yarn]: https://classic.yarnpkg.com/lang/en/ +[chrome]: https://google.com/chrome/ +[firefox]: https://firefox.com/ +[yarn-workspaces]: https://classic.yarnpkg.com/en/docs/workspaces/ +[homebrew]: https://brew.sh +[warp]: https://www.warp.dev +[vscode]: https://code.visualstudio.com/ +[ember-inspector]: https://guides.emberjs.com/release/ember-inspector/ +[postman]: https://www.postman.com/downloads/