tatut / clj-chrome-devtools

Clojure API for controlling a Chrome DevTools remote
MIT License
130 stars 21 forks source link

Add useful guide to start the project locally #4

Closed agilecreativity closed 7 years ago

agilecreativity commented 7 years ago

Thanks for a great library:

I have one suggestion that might be useful for someone to get started with the project:

git clone https://github.com/tatut/clj-chrome-devtools.git
cd clj-chrome-devtools
git submodule init
git submodule update
# then follow the guide in the README to start the REPL
# e.g. 
lein repl 
# or 
lein test
tatut commented 7 years ago

I didn't think about that, I just assumed people would use this as a leiningen dependency.

Perhaps we should have some sort of quick start guide in the gh pages and possibly the README. I'm not certain what form of documentation would be the most helpful, but PRs are certainly welcome.

Another thing that could be useful is an examples folder with a couple of simple projects, like an example e2e test and some screen scraping example.

eerohele commented 7 years ago

I whipped up a quick screen scraping example project while figuring out how to get started with this library, but to be honest, it's practically identical to chrome_test.clj.

Still, if you want the PR, just let me know.

A couple of unrelated things I noticed while working on the example project:

tatut commented 7 years ago

I don't think we need the example, if it's same as the test we currently have.

But I'll gladly take a PR to remove the vestigial println and add URI/URL support for to.

eerohele commented 7 years ago

I don't think we need the example, if it's same as the test we currently have.

Makes sense. Maybe the README could point to the unit tests, though? I certainly found them very useful.

But I'll gladly take a PR to remove the vestigial println and add URI/URL support for to.

OK, I'll see if I can take a look.

Should the println calls be replaced with something like timbre's debug logging?

tatut commented 7 years ago

I added a note about chrome_test to README. I'm closing this issue.