This project is a fork of swagger-ui (https://github.com/swagger-api/swagger-ui) ([email protected]:swagger-api/swagger-ui.git) that does custom changes to the index.html, at the least.
The deployed package should have no dependencies.
Look in the dist/ folder. e.g. dist/index.html has some JavaScript that we customized.
For most development you should neither need to install NPM packages nor run the "build" script.
There is no need to run npm install. You do not need to run npm run build either.
As of November 2023, the files necessary for testing and publishing the package are in the dist and swagger-ui-dist-package.
If for some reason you need to do npm install, then you may need to go back as old as Node 14 to get the outdated packages needed for development installed.
If for some reason you need to do npm run build (to generate a new dist/ folder perhaps), then you would need "npm install" to work, because it installs necessary build tools.
To correct dependency problems, the appropriate course of action might be to pull from a newer fork with updated NPM packages, and merge our work back into the fork.
A test .tgz NPM package will contain copies of files needed for the Swagger UI, including any changes to index.html.
Run swagger-ui-dist-package/deploy.sh to create a test .tgz package, swagger-ui-dist-package/profoundjs-swagger-ui-.tgz.
Copy .tgz to your PJS directory and install it; e.g., npm install profoundjs-swagger-ui-1.2.3.tgz Then test your work in Designer.
Increase the version in the /package.json file, commit, and push that change along with your other changes.
After you commit and push your work to the profoundjs-swagger-ui master branch you can run swagger-ui-dist-package/deploy.sh --publish
You will need an NPM access token. For example, get or request someone create you a Granular Access token with write access to profoundjs-swagger-ui. The, store that token someone that NPM knows to look, e.g. in ~/.npmrc as, e.g.:
//registry.npmjs.org/:_authToken=npm_783947238947298473298479283