search

Bogdan-Lyashenko / codecrumbs

Learn, design or document codebase by putting breadcrumbs in source code. Live updates, multi-language support and more.
https://codecrumbs.io
BSD 3-Clause "New" or "Revised" License
2.71k stars 101 forks source link

cant get it started #17

Closed nalagg closed 5 years ago

nalagg commented 5 years ago

'codecrumbs' is not recognized as an internal or external command, operable program or batch file.

created a dir '\devDependencies', ran yarn

Bogdan-Lyashenko commented 5 years ago

Hey, since you added it as dev dependency you need to add a command to “scripts” section in your package.json and then run it. 1) yarn add codecrumbs -D 2) add to package.json “scripts”: { “cc”: “codecrumbs -d src -e src/index.js” } 3) in terminal run: yarn cc (or npm run cc)

Bogdan-Lyashenko commented 5 years ago

or you can use npx (https://github.com/zkat/npx) or install globally (it's not the best way)

nalagg commented 5 years ago

inside /codecrumbs/src i only see index.dev.js

Bogdan-Lyashenko commented 5 years ago

For what project are you trying to use it? Let's do this example first to understand how everything works: 1) clone/download to your computer this project https://github.com/lucasbento/react-redux-todo (just as simple example) 2) install codecrumbs - yarn global add codecrumbs 3) go to the folder react-redux-todo (where you copied project from step 1) 4) run codecrumbs -d src -e src/index.js 5) go to the browser url http://localhost:2018 to see if it works

let me know if this works

nalagg commented 5 years ago

that worked, thank you. I cloned https://github.com/Bogdan-Lyashenko/codecrumbs.git and this gave problems.

Bogdan-Lyashenko commented 5 years ago

No worries, happy to help :)