search

diplodoc-platform / documentation-template

documentation template with support for codespaces and hot reload via dev server
12 stars 2 forks source link

Quickstart project doesn't run locally #5

Open elw00d opened 2 months ago

elw00d commented 2 months ago

I'm trying to run a fresh quickstart project locally. I run npm start on Ubuntu 22.04, but I'm getting an error:

0 ➜ npm start

> @diplodoc/documentation-template@0.0.0 start /home/elwood/all/diplodoc-example
> npm run build:docs && node scripts/serve.js

> @diplodoc/documentation-template@0.0.0 build:docs /home/elwood/all/diplodoc-example
> yfm --input docs --output docs-html

sh: 1: yfm: not found
npm ERR! code ELIFECYCLE
npm ERR! syscall spawn
npm ERR! file sh
npm ERR! errno ENOENT
npm ERR! @diplodoc/documentation-template@0.0.0 build:docs: `yfm --input docs --output docs-html`
npm ERR! spawn ENOENT
npm ERR! 
npm ERR! Failed at the @diplodoc/documentation-template@0.0.0 build:docs script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.
npm WARN Local package.json exists, but node_modules missing, did you mean to install?

I installed YFM using the command from the official site npm i diagnostics_channel -g, but now there is another error:

130 ➜ npm start

> @diplodoc/documentation-template@0.0.0 start /home/elwood/all/diplodoc-example
> npm run build:docs && node scripts/serve.js

> @diplodoc/documentation-template@0.0.0 build:docs /home/elwood/all/diplodoc-example
> yfm --input docs --output docs-html

internal/modules/cjs/loader.js:883
  throw err;
  ^

Error: Cannot find module 'util/types'
Require stack:
- /home/elwood/.nvm/versions/node/v14.16.1/lib/node_modules/@diplodoc/cli/build/index.js
    at Function.Module._resolveFilename (internal/modules/cjs/loader.js:880:15)
    at Function.Module._load (internal/modules/cjs/loader.js:725:27)
    at Module.require (internal/modules/cjs/loader.js:952:19)
    at require (internal/modules/cjs/helpers.js:88:18)
    at node_modules/undici/lib/web/fetch/util.js (/home/elwood/.nvm/versions/node/v14.16.1/lib/node_modules/@diplodoc/cli/build/index.js:158842:28)
    at __require (/home/elwood/.nvm/versions/node/v14.16.1/lib/node_modules/@diplodoc/cli/build/index.js:48:51)
    at node_modules/undici/lib/web/fetch/headers.js (/home/elwood/.nvm/versions/node/v14.16.1/lib/node_modules/@diplodoc/cli/build/index.js:166232:9)
    at __require (/home/elwood/.nvm/versions/node/v14.16.1/lib/node_modules/@diplodoc/cli/build/index.js:48:51)
    at node_modules/undici/lib/web/fetch/response.js (/home/elwood/.nvm/versions/node/v14.16.1/lib/node_modules/@diplodoc/cli/build/index.js:166679:102)
    at __require (/home/elwood/.nvm/versions/node/v14.16.1/lib/node_modules/@diplodoc/cli/build/index.js:48:51) {
  code: 'MODULE_NOT_FOUND',
  requireStack: [
    '/home/elwood/.nvm/versions/node/v14.16.1/lib/node_modules/@diplodoc/cli/build/index.js'
  ]
}
elw00d commented 2 months ago

Finally I've found out how to make it work. The correct commands are:

npm install
npm start