Not enough documentation on how to get started, what is needed, etc.

[thatkookooguy]

Hi! I've been dying to use happo since I found out this thing exists :-)

The problem is that the documentation is really lacking. I had to search other repos that use this in order to try and figure out how to use it (and the in the wild section of the readme doesn't point to a specific repo).

Here are some problems I encountered while trying to add this:

• [ ] couldn't test this locally since I'm using mac and it seems like xvfb-run is a Linux command (nothing is mentioned about pre-installs for this project. only things you might want to install after happo)
• [ ] no easy to find example project I can just git clone to my computer and run npm run happo on. At least none mentioned in the readme.md
• [ ] shouldn't the script to run happo with just be part of the happo-cli and replace that with some command line arguments for the cli or even attributes in the .happo.js config file?

currently, I tried adding what I understood as the basic files and dependencies needed to try this (on Travis atm.... since I don't have an available Linux machine right now). which are:

• scripts/happo-ci.sh
• .happo.js
• happo-examples.js // currently this is the script I run which is actually unrelated to my app. just for testing if everything works first

here's the PR I did: https://github.com/Kibibit/achievibit/pull/126 and here's the Travis build with happo failing: https://travis-ci.org/Kibibit/achievibit/builds/312330091?utm_source=github_status&utm_medium=notification#fold-start-after_success-0

So, I'm not sure what the problem is... Any help would be appreciated :-)

[trotzig]

I'm sorry to hear you're having issues getting happo set up. I know it can be painful, and that's partly why I'm working on a hosted version of happo right now over at https://happo.io. It's currently in beta, but I can give you early access if you wanted to give it a shot. I'm currently preparing for a public launch, at which time I'll update the README in this repo to explain the differences between the hosted version and the open source version.

[thatkookooguy]

@trotzig I'd love that a lot :-)

I see the site says it's for React, but I saw some examples without React. It can be used with any framework (including no framework at all), right?

[thatkookooguy]

@trotzig what's the difference between the site and this repo?

I'm trying to use this in an open-source organization and I see that after the beta there's going to be a fee. So I guess the site is for closed-source organizations, right?

Is there a free plan as well? Will joining the beta be relevant if I can't use the site after it gets out of beta?

[oliviertassinari]

@Thatkookooguy If your are interested in supporting a open-source organization, maybe you can have a look at the solution used by Material-UI: Argos-CI. I have added an integration example with Happo.

[oliviertassinari]

@Thatkookooguy Or you can have a look at a live integration example with react-algolia, storybook and Happo.

[thatkookooguy]

@oliviertassinari thanks for the links. I'm not sure if it makes this problem easier though... It looks like your code is coupled with react and webpack, which I don't use in all my projects.

I'll try and fish out some of the happo commands you use and try and implement something without react and webpack.

I'm trying to understand how to add happo with, let's say, a vanilla javascript project.

[trotzig]

@Thatkookooguy there will be a free open source plan. I already have a few open source projects using the beta. It will be on request though to begin with, just to make sure I have enough resources (servers, storage) to take care of all the traffic.

The current version of the happo.io client is React-only, but in theory the renderer is pluggable. I'm currently in discussion with an org using ember, and plain js will be even easier.

I'll send you an email with an introduction.