swagger-api / swagger-api/swagger-ui
Development Environment Installation
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
Q&A (please complete the following information)
- OS: Windows
- Browser:
- Version: master
- Method of installation: npm
- Swagger-UI version: master
- Swagger/OpenAPI version:
Content & configuration
I am following this guide:
https://github.com/swagger-api/swagger-ui/blob/master/docs/development/setting-up.md
I have this error:
C:\Users\aoviedoalvarez\Downloads>git clone git@github.com:swagger-api/swagger-ui.git
Cloning into 'swagger-ui'...
ssh: connect to host github.com port 22: Connection timed out
fatal: Could not read from remote repository.
Please make sure you have the correct access rights
and the repository exists.
However, I cloned the repository but now I have an npm install error:
C:\Users\aoviedoalvarez\Downloads\swagger-ui>npm install
npm ERR! Error while executing:
npm ERR! C:\Program Files\Git\cmd\git.EXE ls-remote -h -t git://github.com/ev1stensberg/generator.git
npm ERR!
npm ERR! fatal: unable to connect to github.com:
npm ERR! github.com[0: 192.30.253.113]: errno=No such file or directory
npm ERR! github.com[1: 192.30.253.112]: errno=No such file or directory
npm ERR!
npm ERR!
npm ERR! exited with error code: 128
I am surely missing something. Please help me.
Example Swagger/OpenAPI definition:
# your YAML here
Swagger-UI configuration options:
SwaggerUI({
// your config options here
})
?yourQueryStringConfig
Describe the bug you're encountering
To reproduce...
Follow this guide: https://github.com/swagger-api/swagger-ui/blob/master/docs/development/setting-up.md
Error on npm install
Steps to reproduce the behavior:
- Go to '...'
- Click on '....'
- Scroll down to '....'
- See error
Expected behavior
Screenshots
Additional context or thoughts
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with docs/development/setting-up.md and compare its instructions with the reported Windows git clone and npm install errors. Determine whether the guide needs clearer Windows-compatible setup guidance; done when the documented steps address the installation problem described in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, javascript, nodejs
- Domain
- build-system, developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100