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

RFC: Monorepo #1050

Open
emersonlaurentino opened this issue Feb 18, 2020 · 3 comments
Open

RFC: Monorepo #1050

emersonlaurentino opened this issue Feb 18, 2020 · 3 comments
Assignees

Comments

@emersonlaurentino
Copy link
Member

Using mono-repository to separate the documentation and builder-hub components, many of our current dependencies are due to the documentation.

Possible structure of the monorepo:

packages
├── components
│   └── src
│       └── Button
│           ├── tests
│           │   ├── snapshots
│           │   │   └── index.test.tsx.snap
│           │   └──index.test.tsx
│           └── index.tsx
├── site
└── vtexio
    └── react
        └── Button.tsx
  • inside the components folder are actually the components and their builder.
  • inside the site folder is the documentation of the components (importing from the components folder) and the builder of the documentation.
  • inside the vtexio folder are the files that will be built within the VTEX IO infrastructure using the builder-hub; Just like site, this folder only imports files from the components folder.
@lucasecdb
Copy link
Contributor

can I suggest to rename the site package to docs?

@emersonlaurentino
Copy link
Member Author

whatever, it is just a name for where the documentation will be, not only of the components, but of the complete Design System.

@kaisermann
Copy link
Contributor

I've gave this a try some time ago and made a little POC: https://github.com/vtex/styleguide/tree/refactor/monorepo+lerna+workspaces if it helps anyone

@emersonlaurentino emersonlaurentino changed the title Using Monorepo RFC: Monorepo Mar 2, 2020
@emersonlaurentino emersonlaurentino self-assigned this Mar 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants