-
-
Notifications
You must be signed in to change notification settings - Fork 346
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update development.md
, fix incorrect local development steps
#2750
Conversation
Reviewer's Guide by SourceryThis PR updates the local development setup instructions in Flow diagram for updated local development setup processgraph TD
A[Start Development] --> B[pnpm install]
B --> C[pnpm bootstrap]
C --> D[pnpm start:app]
D --> E[Access localhost:4200]
subgraph Build Options
F[pnpm build] --> G[dist/ directory]
H[pnpm build-ext] --> I[chrome-extension/ directory]
J[pnpm build-electron] --> K[electron-builds/ directory]
L[pnpm test] --> M[Run all package tests]
end
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
development.md
fix incorrect local development stepsdevelopment.md
, fix incorrect local development steps
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @that-one-arab - I've reviewed your changes - here's some feedback:
Overall Comments:
- Please fill out the PR template, particularly the 'Fixes #' section to reference the related issue.
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Run `yarn start:app` to start the local dev server of the web app. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files. | ||
Run `pnpm install` from the root of the repository to install dependencies. | ||
|
||
Run `pnpm bootstrap` to build local projects, this is necessary to compile JS into TS and make sure types imported from other projects are accessible |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
issue (typo): Typo: 'JS into TS' should be 'TS into JS'.
There seems to be a typo in this line. It should probably read 'TS into JS' instead of 'JS into TS'.
Run `pnpm bootstrap` to build local projects, this is necessary to compile JS into TS and make sure types imported from other projects are accessible | |
Run `pnpm bootstrap` to build local projects, this is necessary to compile TS into JS and make sure types imported from other projects are accessible |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks
Fixes
Checks
yarn test-build
Changes proposed in this pull request:
Summary by Sourcery
Update local development instructions to use
pnpm
instead ofyarn
for managing dependencies, building the project, generating Chrome extension files, building Electron apps, and running tests. Add apnpm bootstrap
step to build local projects and compile JS into TS.Enhancements:
yarn
topnpm
for package management.Documentation:
yarn
topnpm
.