Skip to content

Commit

Permalink
docs(engineer-hardware-software-setup): add doc
Browse files Browse the repository at this point in the history
  • Loading branch information
BorysShulyak committed Oct 18, 2024
1 parent 26bd000 commit 6cd41ef
Show file tree
Hide file tree
Showing 3 changed files with 78 additions and 5 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
title: Engineering Team Hardware and Software Setup
---

# Engineering Team Hardware and Software Setup

Use this doc as a template.

## Why do you need the infromation about setup of your team

- **Compatibility**: Ensuring that all team members have compatible systems can prevent issues related to software development and testing.
- **Optimization**: Understanding the hardware capabilities can help in optimizing the development environment and workflows.
- **Troubleshooting**: Detailed setup information can aid in diagnosing and resolving technical issues more efficiently.
- **Standardization**: Helps in maintaining a standardized development environment across the team, which can improve collaboration and productivity.
- **Resource Allocation**: Assists in planning and allocating resources effectively based on the hardware and software capabilities of the team members.

## How to fill the information

1. Run `npx envinfo --system --binaries --browsers --IDEs --languages --npmGlobalPackages --markdown` in your terminal.
2. Add an additional infromation about IDEs and AI tools.

### Engineer 1

```
System:
OS: macOS 14.1.2
CPU: (10) arm64 Apple M1 Pro
Memory: 176.31 MB / 16.00 GB
Shell: 5.9 - /bin/zsh
Binaries:
Node: 20.9.0 - ~/.nvm/versions/node/v20.9.0/bin/node
npm: 10.1.0 - ~/.nvm/versions/node/v20.9.0/bin/npm
pnpm: 8.14.3 - ~/.nvm/versions/node/v20.9.0/bin/pnpm
IDEs:
VSCode
Vim: 9.0 - /usr/bin/vim
Xcode: /undefined - /usr/bin/xcodebuild
Languages:
Bash: 3.2.57 - /bin/bash
Go: 1.21.3 - /usr/local/go/bin/go
Java: 21.0.1 - /usr/bin/javac
Perl: 5.30.3 - /usr/bin/perl
PHP: 8.3.12 - /opt/homebrew/bin/php
Python3: 3.12.0 - /usr/local/bin/python3
Ruby: 2.6.10 - /usr/bin/ruby
Browsers:
Brave Browser: 128.1.69.162
Chrome: 129.0.6668.101
Safari: 17.1.2
npmGlobalPackages:
@microsoft/rush: 5.112.2
@nestjs/cli: 10.4.2
corepack: 0.20.0
generator-danger-plugin: 1.3.1
npm: 10.1.0
pnpm: 8.14.3
typescript: 5.5.3
yo: 5.0.0
AI:
Copilot
```

### Engineer 2

...
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,17 @@ title: Recommended Soft
- [Material Icon Theme](https://github.com/PKief/vscode-material-icon-theme)
- [Palenight Theme](https://github.com/whizkydee/vscode-palenight-theme)

## AI

- [Cursor](https://www.cursor.com/)
- [Copilot](https://github.com/features/copilot)
- [Claude](https://claude.ai)
- [ReclaimAi](https://reclaim.ai/)

## Browser Plugins

- [Apollo Client Devtools](https://chrome.google.com/webstore/detail/apollo-client-developer-t/jdkknkkbebbapilgoeccciglkfbmbnfm)
- [Tanstack Query Devtools](https://tanstack.com/query/latest/docs/framework/react/devtools)
- [Grammarly](https://www.google.com/aclk?sa=l&ai=DChcSEwim992Q8aaDAxVwlYMHHd9WA-IYABAAGgJlZg&ase=2&gclid=CjwKCAiAp5qsBhAPEiwAP0qeJv2s6QRo5ZyhIgAbWmGoXDFU-3pLzTZ6N5QWNa7GOAFnglSxv9B0EBoCGcQQAvD_BwE&sig=AOD64_1XYVnrFelh-p8UfxrsQXAuwDwPPA&q&nis=4&adurl&ved=2ahUKEwi399aQ8aaDAxX6Q_EDHZ9-Ac0Q0Qx6BAgFEAE)

## Databases
Expand All @@ -61,16 +69,13 @@ title: Recommended Soft
## Management

- [Click Up](https://clickup.com/?utm_source=google&utm_medium=cpc&utm_campaign=gs_cpc_em_nnc_brand_trial_all-devices_troas_lp_x_all-departments_x_brand&utm_content=all-countries_kw-target_text_all-industries_all-features_all-use-cases_clickup_exact&utm_term=e_clickup&utm_creative=651395810831_BrandChampion-03072023_rsa&utm_custom1=&utm_custom2=&gad_source=1&gclid=CjwKCAiAp5qsBhAPEiwAP0qeJtfN_G9udOSwSQ9yAK-eaEQeJ_wINTEc4yqb0OHaV6UJptnHVgBmVBoCjxYQAvD_BwE)
- [Linear](https://linear.app/homepage)
- [Basecamp](https://basecamp.com/)
- [Resource Guru](https://resourceguruapp.com/)
- [Harvest](https://www.getharvest.com/)
- [Mural](https://www.mural.co/)
- [ReclaimAi](https://reclaim.ai/)
- [Slack](https://slack.com/intl/en-gb/)

## Screen(Bugs) Recording

- [Loom](https://www.loom.com/)
- [jam.dev](https://jam.dev/)

## Productivity
Expand Down
5 changes: 4 additions & 1 deletion apps/archive/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,10 @@ const sidebars = {
{
type: 'category',
label: 'Developer Experience',
items: ['engineering-playbook/developer-experience/recommended-soft']
items: [
'engineering-playbook/developer-experience/engineer-hardware-software-setup',
'engineering-playbook/developer-experience/recommended-soft'
]
},
{
type: 'category',
Expand Down

0 comments on commit 6cd41ef

Please sign in to comment.