benoitc / benoitc/erica

More documentation would help newcomers

Open
#101 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
264
Forks
30
PR merge metrics
No merged PRs in 30d

Description

I'm just starting out with erica. So far so good: I overcame the little installation niggles, and I have a working application created via "erica create-webapp appid=xxx", but I am starting to wonder what the app.webapp file data is for, which parts are necessary and which optional, what the various erica commands do in detail, etc.

There seem to be few clues, so I am going to have to make more guesswork about my next steps. I have looked, but I can't find very much information online, nor in the source code. Erlang itself is incomprehensible to me, currently, and I see no comments. Not to mention that the couchapp.org site isn't working, which contains much information I need, I suspect.

I wonder if erica works like couchapp? Even if it did, https://github.com/couchapp/couchapp is not much more help. http://stackoverflow.com/questions/5629075/couchapp-directory-structure-updates might be helpful if I could reach couchapp.org.

Finally, reading the google group for couchapp reveals more unanswered questions like mine, which doesn't bode well. https://groups.google.com/forum/#!topic/couchapp/-9bvReMubQ4 suggests couchapp.org has been down for at least four months.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the documented `erica create-webapp appid=xxx` entry point and inspect the generated `app.webapp` file. Determine which fields are necessary or optional, describe the erica commands and their details, and explain any relationship to couchapp; done means a newcomer can continue without relying on unavailable external sites.

Written by the indexing model from the issue text.

Assessment

Tech stack
erlang, javascript
Domain
cli, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.