Skip to content
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

Clowder v2 Dev Setup #1143

Open
longshuicy opened this issue Jul 10, 2024 · 3 comments
Open

Clowder v2 Dev Setup #1143

longshuicy opened this issue Jul 10, 2024 · 3 comments
Assignees

Comments

@longshuicy
Copy link
Member

longshuicy commented Jul 10, 2024

Let's divide the work to come up with slides:

Github @longshuicy

  • Briefly touch upon: Create github account if not already have one; github basic layout etc
  • How to create issues in Clowder2
  • How to create branch related to issue
  • How to open PR/draft PR
  • What's the review process

Pycharm @tcnichol

  • Download PyCharm Community Edition (https://www.jetbrains.com/pycharm/download/)
  • Installing PyCharm community edition
  • How to Clone the project in pycharm or via command line
  • How to open the project
  • Switch to a branch

Install Libraries @ddey2

  • pipenv
  • npm
  • pre-commit

Set up Docker @ddey2

  • Install Docker
  • Briefly walk through Docker desktop
  • Explain docker-compose vs docker-compose.dev.
  • Focus on run docker-dev.sh, explain docker-compose.dev.yaml etc

Run and Debug @tcnichol

  • Regular run
  • especially react debugging

Pre-commits @longshuicy

  • Install pre-commit library
  • Install pre-commit hook
  • Demo an example of how pre-commit works

Optional: VScode

Optional:

  • Browser inspect mode
  • Network tabs
  • Common command line

For more references, here is a write up for IN-CORE project: https://docs.google.com/document/d/14MZlI75SKXn0fVDMC_gCNhaJxR0cBcuPb4sK-OK04oQ/edit#heading=h.lhw1m8y6xnzj

@tcnichol
Copy link
Contributor

Could I take the PyCharm part? I can volunteer for that one.

@tcnichol
Copy link
Contributor

I added some placeholder slides.

Since 'install' was covered by someone else's issues, I put some in but am leaving those blank. I will focus on the running and debugging front end and back. I'll probably add a small video that shows debugging the front end and back end.

@tcnichol
Copy link
Contributor

I think I have a first draft for the PyCharm section that covers all the content we need. Added videos for debugging front end and back end.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

3 participants