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

Improve README #88

Open
gr2m opened this issue Mar 7, 2016 · 0 comments
Open

Improve README #88

gr2m opened this issue Mar 7, 2016 · 0 comments
Assignees

Comments

@gr2m
Copy link
Member

gr2m commented Mar 7, 2016

Take https://github.com/hoodiehq/hoodie-client-account as an example. It’s a lot of work, but this can be done step-by-step, and I’m happy to work with you on it :)

Just to get this going, setup the repository locally and run tests:

git clone git@github.com:hoodiehq/hoodie-client-store.git
cd hoodie-client-store/
npm install
npm test

npm test should end with

  total:     173
  passing:   173
  duration:  1.3s

Playing with the APIs is probably simplest in a browser. We don’t have a demo server build in (yet), but you can do this:

# build the client story library for the browser
npm run build
# copy the client store code to your clipboard
cat dist/hoodie-client-store.js | pbcopy

Now open any website like http://example.com/, open browser console, and paste in the code from your clip board. Store is now available :)

screen shot 2016-03-12 at 18 50 03

Now you can run the code shown in the README API section and see how it behaves.

Also compare https://github.com/hoodiehq/pouchdb-hoodie-api & https://github.com/hoodiehq/pouchdb-hoodie-sync where most of the APIs are coming from, and look around the code :)

@alinebastos alinebastos self-assigned this Mar 15, 2016
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

2 participants