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 issues after installation #41

Open
JoshuaDietz opened this issue Jan 10, 2021 · 3 comments
Open

Multiple issues after installation #41

JoshuaDietz opened this issue Jan 10, 2021 · 3 comments

Comments

@JoshuaDietz
Copy link

Hello,
this probably needs to be split into multiple issues later. After installation I had a few issues which I had to work around and I first wanted to know if I'm the only one having these issues or if there are bugs which need to be fixed:

I Installed OpenDocumenter with the line from the instructions npm install -g opendocumenter
Running OpenDocumenter was only possible with the fix from #19

Then I ran it with opendocumenter --schema=./path-to-my-schema --output=./path-to-out-dir
I received !!! Aborting due to error: ENOENT: no such file or directory, lstat 'package.json' so I added a basic package.json to the folder containing my schema (even though I don't get why this is necessary).

The next error I got was `sh: line 1: vue-cli-service: command not found

!!! Aborting due to error: Shell command exit with non zero code: 127`

which I fixed with npm i -g @vue/cli-service and npm i -g vue-template-compiler

Now the OpenDocumenter seems to build the documentation. But when serving it via a local webserver (running from file won't work due to same origin policy) the browser console reports Uncaught (in promise) TypeError: t.tags is undefined

That's my current status.

I'm posting this to ask if anyone else has these issues and if so to share the steps which fixed some of the issues for me.

@github-actions
Copy link
Contributor

Thank you for opening your first issue! Please ensure you've read the CONTRIBUTING.md and CODE_OF_CONDUCT.md files.

@timwsuqld
Copy link

I'm finding the same issues as @JoshuaDietz

@arturorh
Copy link

arturorh commented Apr 16, 2021

Hello Joshua,
I also had the same issues you had and I followed your solutions and finally I was able to see the documentation working.

If you also obtain the following logs:
DONE Build complete. The dist directory is ready to be deployed.
INFO Check out deployment instructions at https://cli.vuejs.org/guide/deployment.html

The last things you need to execute are the following:

npm install -g serve
-s flag means serve it in Single-Page Application mode

serve -s dist
dist is the output folder name I used when I executed opendocumenter

I hope you can see your documentation working :-)

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

3 participants