Can't visit the docs

[reddish-brick]

Hi Team,
I can initiate the application successfully locally, but I can't visit the docs page by http://localhost:3000/docs, could you help look at this issue?

Best Regards

[oglimmer]

Hi,

could you please check that you did the following steps:

# after cloning the project
npm i
npm run docs # this needs npx installed!!
# you should see "Documentation generated at /Users/oglimmer/dev/scriptable-ocpp-chargepoint-simulator/public/docs" as the last output line
npm run dev

Now you should be able to see the docs at http://localhost:3000/docs
This looks a bit like the README.md but on the right side of the screen, you'll find a menu with links to the different JS objects. you can also use http://localhost:3000/docs/globals.html to see the docs for the global variables directly.

[reddish-brick]

Hi,
i just execute this command 'npx typedoc --out public/docs' then I can generate the docs, but looks like the content of the docs is similar to the README.md, so I still don't know how to use this service(don't know the interacting process between simulator and central system), do you have some more detailed operation guide? thanks

[oglimmer]

as said, on the right side is a menu which gives you links to the various JS objects.

Try http://localhost:3000/docs/globals.html to see a better "portal".