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

DX w/ monorepo tooling #803

Open
luixo opened this issue Dec 10, 2021 · 4 comments
Open

DX w/ monorepo tooling #803

luixo opened this issue Dec 10, 2021 · 4 comments
Labels

Comments

@luixo
Copy link
Contributor

luixo commented Dec 10, 2021

Story

As a developer who just started working on projects, I stumbled upon a bump while bootstrapping the app. The repository seems to be monorepo, but lacks appropriate tooling (e.g. lerna, pnpm). There is no instruction for a developer to run npm i in every folder you're going to work in, and default npm i in root folder didn't help much. Combining with wild-card module declaration (which is in my belief smelly code by itself) it caused me to dig for some time why every module in project is broken and linked to wildcard module declaration.

Proposals

  • add monorepo tooling (probably later, it takes more than just a couple of steps)
  • add bootstrap instructions in every sub-repo
  • be more developer-friendly, even if a developer came from non-nodejs world (to fix something pretty trivial, for example)
@frol
Copy link
Collaborator

frol commented Dec 10, 2021

There are just two subprojects (backend and frontend), so it felt like an overkill to introduce extra tooling for that. My plan was to use docker-compose as the way to document how to run the project altogether.

P.S. cli folder should be removed: #804

@frol frol added Priority 3 refactoring code, configuration clean ups labels Dec 10, 2021
@luixo
Copy link
Contributor Author

luixo commented Dec 10, 2021

As of my experience, in this kind of setup (just client and server) package.json is usually shared.
Anyway, I believe a little extra documentation won't hurt anyone

@frol
Copy link
Collaborator

frol commented Dec 10, 2021

Meh, I don't think it is a good idea to mix client and server dependencies / commands since that may cause various unexpected issues.

P.S. I am all for improvements to documentation 👍

@luixo
Copy link
Contributor Author

luixo commented May 19, 2023

This might do it.

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

No branches or pull requests

2 participants