carteb / carte-blanche

An isolated development space with integrated fuzz testing for your components. See them individually, explore them in different states and quickly and confidently develop them.
https://www.youtube.com/watch?v=6g3-TQ6aaw8
MIT License
1.5k stars 47 forks source link

Add docs for /examples #367

Closed kevinSuttle closed 8 years ago

kevinSuttle commented 8 years ago

e.g. There are no docs for running the server other than

now start your development environment

Webpack dev server gives me cannot Get /carte-blanche

mxstbr commented 8 years ago

Which server are you using? Express.js?

kevinSuttle commented 8 years ago

Webpack dev server, which uses Express under the hood. https://github.com/webpack/webpack-dev-server/blob/master/package.json#L12

mxstbr commented 8 years ago

Wait, are you running the examples of this repo?

kevinSuttle commented 8 years ago

Yeah...

mxstbr commented 8 years ago

npm run example:directoryname runs the examples, e.g. npm run example:dev.

What kind of docs do you expect for the examples?

kevinSuttle commented 8 years ago

What you just posted is a great start. :)

mxstbr commented 8 years ago

They're mostly meant for us maintainers to help develop for different setups! They mostly aren't very exciting :grin:

kevinSuttle commented 8 years ago

Fair enough. It's just hard to know how to get CB set up and running on a given server.

mxstbr commented 8 years ago

Shouldn't be much more difficult than

new CarteBlanche({
  componentRoot
});

in your webpack configuration. If it doesn't work with a specific server setup please submit an issue for that!