Comments (3)
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.
from scriptable-ocpp-chargepoint-simulator.
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
from scriptable-ocpp-chargepoint-simulator.
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".
from scriptable-ocpp-chargepoint-simulator.
Related Issues (3)
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from scriptable-ocpp-chargepoint-simulator.