Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add useful guide to start the project locally #4

Closed
agilecreativity opened this issue Sep 8, 2017 · 5 comments
Closed

Add useful guide to start the project locally #4

agilecreativity opened this issue Sep 8, 2017 · 5 comments

Comments

@agilecreativity
Copy link
Contributor

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
Copy link
Owner

tatut commented Sep 8, 2017

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
Copy link
Contributor

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:

  • Is this println intentional? It adds quite a bit of noise into the test output.
  • It might be nice if to also accepted java.net.URI (and maybe java.net.URL) in addition to a string.

@tatut
Copy link
Owner

tatut commented Sep 18, 2017

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
Copy link
Contributor

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 tatut closed this as completed Sep 18, 2017
@tatut
Copy link
Owner

tatut commented Sep 18, 2017

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants