microsoft / PowerBI-visuals-TimelineStoryteller

Timeline Storyteller PowerBI Visualization
MIT License
22 stars 15 forks source link

Cannot resolve module 'timeline_storyteller' #1

Open alxdean opened 6 years ago

alxdean commented 6 years ago

Hey folks, After downgrading to Node 6.14 I was able to get Yarn to install all dependencies. a yarn-test even gave back an all-clear. but when I try to package the project using yarn package I hit an error with " Cannot resolve module 'timeline_storyteller'" I noticed that timeline_storyteller is included in the package-lock.json but does not seem to form part of the actual project. it is the name of the original nodejs project that's not powerbi enabled. Am I missing a critical component somewhere? I'd love to build this component on my computer and make some minor tweaks to it. but I simply can't get it to .

I think this line is what's causing the issue const TimelineStorytellerImpl = require('timeline_storyteller');

it looks like it's self referencing? am I missing a dependency? do I need to build the web project first before building the PowerBI project?

stopyoukid commented 6 years ago

Thank you for reporting the issue, seems there were some steps missing from the README. I've just updated the readme to include the additional steps. The gist is, Timeline Storyteller needs to be built from source and yarn linked in, since it isn't published to npm.

Hopefully this helps, let us know if it doesn't.

alxdean commented 6 years ago

I thought nearly as much! Was tearing my hairs out thinking I was chasing some sort of circular reference. Thanks for clarifying the build steps. Please also include the fact that the project is incompatible with Node 8+ due to the version of Sass being used. Took some time to figure that out. As I was not adventurous enough to upgrade the references in the project I downgraded node instead. Also I ended up installing python 2.7 to get it all going.

Alex Dean Business Consultant https://www.linkedin.com/in/alxdean Phone: +61 452 585 440

Sent from a very small screen with an even smaller keyboard and a rather quirky auto-correct engine.


From: David Tittsworth notifications@github.com Sent: Thursday, September 27, 2018 2:19:20 AM To: Microsoft/PowerBI-visuals-TimelineStoryteller Cc: Alex Dean; Author Subject: Re: [Microsoft/PowerBI-visuals-TimelineStoryteller] Cannot resolve module 'timeline_storyteller' (#1)

Thank you for reporting the issue, seems there were some steps missing from the README. I've just updated the readme to include the additional steps. The gist is, Timeline Storyteller needs to be built from source and yarn linked in, since it isn't published to npm.

Hopefully this helps, let us know if it doesn't.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHubhttps://github.com/Microsoft/PowerBI-visuals-TimelineStoryteller/issues/1#issuecomment-424776955, or mute the threadhttps://github.com/notifications/unsubscribe-auth/AHbNweWge23cyGt1b4ylbOH4cm48K1NXks5ue6kIgaJpZM4W68XZ.

alxdean commented 6 years ago

Final comment, I had to change the guid in the pbiviz.json to force PowerBI to load my local copy instead of reverting to the official version from the app store!!

alxdean commented 6 years ago

OK. I give up. I'm trying to debug this visual using 'pbiviz start' and I'm hitting a brick wall! My visual simply won't build using the pbiviz command. it will package nicely using yarn though. I think it might have something to do with the dataview module as I've tried many attempts at getting the package to load in the debugger. @stopyoukid , any chance you could give this project a go using a clean repo and getting it to build in pbiviz? I'd really like to debug the changes I'm attempting to make but can't get it to load into the visual debug environment.

alxdean commented 6 years ago

here is my files array: "files": [ ".api/v1.6.0/PowerBI-visuals.d.ts", "lib/powerbi-visuals-utils-dataviewutils/index.ts",
"src/dataConversion.ts", "src/interfaces.ts", "src/settings.ts", "src/utils.ts", "src/lib/calcUpdateType.ts", "src/lib/UpdateType.ts", "src/TimelineStoryteller.spec.ts", "src/TimelineStoryteller.ts"

]

stopyoukid commented 6 years ago

Good point on the guid, I should add a note.

So, before I updated the README, I did do a clean build of both timelinestoryteller and this repo, and it seemed to work just fine.

Sorry for all the problems you are having. I think most of it stems from the fact that we don't use the pbiviz build system. Their tools currently don't support some of the more advanced things that we do. For instance, with ours, you don't need to modify the files array at all, it will just work. Our tools let you develop visuals as if they were node apps (so using require to get modules instead of the files array). Anyhow, what we currently support is a more lengthy dev loop, you run yarn test, this generates a pbiviz, you import into PowerBI, and then set breakpoints look at the console. Rinse and Repeat.

That being said, we do have a start command which will let you use the developer visual, and if you are feeling adventurous, you could try it we just don't support it very well. You can try it by running yarn start.

My Steps

It looks like you've made quite a few changes, so what I would do is start from scratch. Here are my exact steps that I followed:

git clone https://github.com/Microsoft/timelinestoryteller.git
git clone https://github.com/Microsoft/PowerBI-visuals-TimelineStoryteller.git
cd timelinestoryteller
yarn
yarn test
yarn unlink #also run this if you are running it on the same machine
yarn link
cd ..
cd PowerBI-visuals-TimelineStoryteller
yarn
yarn link timeline_storyteller
yarn package

# Make sure a pbiviz was produced in dist folder
# test in powerbi

# install the certificate
yarn install-certificate

This last command you only need to do once, but follow this guide, skip step 1 once you get to your OS

Finally:

yarn start
# Use developer visual

I also I verified it works on OSX & Windows. Hopefully this helps. I'm also going to add the Python & Node notes to the readme.

alxdean commented 6 years ago

Perfect! That all makes sense. As I said, it builds and packages with yarn using your steps. knowing that it's not compatible (at all) with pbiviz helps me stop barking up the wrong tree. I'll give yarn start a try but understand that it's not supported

pathwhite25 commented 4 years ago

I’ve spent a lot of time creating a timeline and cannot see a way to share it... I’m making it on iPhone 11 and want to share it to youtube or save to my files