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

Multiple errors after installing docz #1735

Open
lauraceconi opened this issue Jun 24, 2022 · 11 comments
Open

Multiple errors after installing docz #1735

lauraceconi opened this issue Jun 24, 2022 · 11 comments

Comments

@lauraceconi
Copy link

lauraceconi commented Jun 24, 2022

Bug Report

Describe the bug

I'm getting multiple errors when following the installation and run instructions in docz documentation.

To Reproduce

  1. Inside an empty folder, run yarn add docz react react-dom
  2. Once the install is finished, add the following scripts to you package.json:
"scripts": {
    "docz:dev": "docz dev",
    "docz:build": "docz build",
    "docz:serve": "docz build && docz serve"
  }
  1. Run yarn docz:dev
  2. See the first error Error: Cannot find module 'typescript'
  3. Install Typescript: yarn add typescript
  4. Run yarn docz:dev again
  5. See error Can't resolve '@emotion/core' in...
  6. Install emotion: yarn add @emotion/core
  7. Run yarn docz:dev again
  8. More errors: Error [ERR_REQUIRE_ESM]: Must use import to load ES Module
    image

image

Expected behavior

To run yarn docz:dev and yarn docz:serve without errors.

Environment

  • docz version: 2.4.0
  • OS: OSX 12.3.1
  • Node/npm version: Node v14.18.3/npm 6.14.15
@lauraceconi lauraceconi changed the title Multiple errors when installing docz Multiple errors after installing docz Jun 24, 2022
@Xiphe
Copy link

Xiphe commented Aug 2, 2022

Can confirm this issue

@lauraceconi
Copy link
Author

lauraceconi commented Aug 2, 2022

I was able to mitigate this problem by installing specific lib versions. So, to properly run docz in development do:
yarn add docz [email protected] [email protected] typescript @emotion/[email protected]

Then add the scripts in your package.json:

"scripts": {
  "docz:dev": "docz dev",
  "docz:build": "docz build",
  "docz:serve": "docz build && docz serve"
}

And run yarn docz:dev. Now you can navigate to localhost:3000 to see it running.

@Xiphe
Copy link

Xiphe commented Aug 2, 2022

Ah thanks! I eventually gave up on docz and am evaluating https://github.com/facebook/docusaurus now

@rozzzly
Copy link

rozzzly commented Aug 3, 2022

Ah thanks! I eventually gave up on docz and am evaluating https://github.com/facebook/docusaurus now

Same. Docz appears to be dead/unmaintained. Numerous issues (#1719, #1731, #1674) where the "fix" is to pin some dep like a 2019 react release isn't a real solution. To be fair, a large part of this is because of upstream issues with various deps.

#1634 appears to indicate one of the maintainers is no longer active. I would suggest adding a note at the top of the README.md making it clear that there's not active development. It took me a few hours of tinkering trying to resolve these issues to come to this conclusion. I would have appreciated knowing that before it got started.

@pedronauck
Copy link
Member

@renatobenks is the actual maintainer of the project guys, he can talk better about maintaining

@Xiphe
Copy link

Xiphe commented Aug 3, 2022

Thanks @pedronauck and big thanks anyone who put work into this project. I know the burden of keeping stuff up to date and running myself.

@calebpanza
Copy link

Wondering if there's any update on this. Trying to avoid using Storybook if possible cause it can be such a headache. I LOVE the setup of docz but won't be able to use it if this problem persists...

@Xiphe
Copy link

Xiphe commented Aug 20, 2022

Hey @calebpanza 👋 as mentioned above, you might want to give docusaurus a shot. Or react styleguidist

@Xiphe
Copy link

Xiphe commented Aug 20, 2022

Would anyone be interested in rebuilding this project?

@calebpanza
Copy link

@Xiphe have you used Docusaurus on a React Native project? How was the experience? I'm trying to avoid Storybook if possible. Lol

@Xiphe
Copy link

Xiphe commented Aug 22, 2022

No, have not used Docusaurus in production yet. But it sticked out when I was researching alternatives to storybook and docz.

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

No branches or pull requests

5 participants