couchdb-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Garren Smith>
Subject Getting started with Fauxton (Was: Re: Committer nominations welcome)
Date Mon, 11 Mar 2013 15:05:59 GMT
Getting started is pretty straight forward. 

1. Clone the Couchdb repo: or
2. Switch to the fauxton branch (git checkout fauxton) We will be moving Fauxton into master
3. cd couchdb/src/fauxton
4. Make sure node and npm are installed
5. npm install to get all the dependancies.
6. bbb couchapp_deploy - to deploy to your local Couchdb instance (http://localhost:5984/fauxton/_design/fauxton/index.html)
7. Read the and and then for some things that need to
be done.

Understanding the code:
Each bit of functionality is its own seperate module or addon. All core modules are stored
under app/module and any addons that are optional are under app/addons.
We use backbone.js ( and Backbone.layoutmanager quite heavily (
so best to get an idea how they work.  Its best at this point to read through a couple of
the modules and addons to get an idea of how they work. I would recommend starting with something
easy like app/addon/config then take a look at app/modules/databases. Each module must have
a base.js file, this is read and compile when Fauxton is deployed. A resource.js file is usually
for your Backbone.Models and Backbone.Collections, view.js for your Backbone.Views. The routes.js
is used to register a url path for your view along with what layout, data, breadcrumbs and
api point is required for the view. 

That should hopefully get you started Fauxton. If you have any more questions let me know
and I or one of the other Fauxton committers can will help you out. I'm also in the couchdb
irc channel as garren. 


On 11 Mar 2013, at 4:36 PM, Dominic Barnes <> wrote:

> How can I get started? Any wiki pages or other resources I can refer to? A
> walk-through of the code would be awesome. :)
> On Mon, Mar 11, 2013 at 9:29 AM, Noah Slater <> wrote:
>> This is excellent news Dominic!
>> On 11 March 2013 14:22, Dominic Barnes <> wrote:
>>> I would love to contribute to Fauxton. (I've learned some Erlang but
>> don't
>>> feel proficient yet)  I love CouchDB and I'd like to contribute right
>> away.
>>> :)
>>> - Dominic Barnes
>>> On Mon, Mar 11, 2013 at 2:08 AM, Garren Smith <>
>> wrote:
>>>> Another way that you can contribute is to help us with Fauxton. Fauxton
>>> is
>>>> all javascript, css and html so no Erlang required.
>>>> If you are interested in contributing let us know and we can walk you
>>>> through the code and get you started.
>>>> There is plenty of low hanging fruit to get you started.
>>>> Garren
>>>> On 09 Mar 2013, at 11:01 PM, Noah Slater <> wrote:
>>>>> Dear community,
>>>>> I believe we have done a poor job of recognising merit in this
>> project.
>>>> As
>>>>> a PMC member, I would like to apologise to you for that. Over the
>>> course
>>>> of
>>>>> this year, I hope to rectify the situation. But I need your help.
>>>>> I would like to invite the whole community to start making committer
>>>>> nominations to the PMC.
>>>>> The sorts of things we're looking for:
>>>>> * Ability to work co-operatively with peers
>>>>> * Ability to mentor others
>>>>> * An understanding of community
>>>>> * Positive, helpful attitude
>>>>> * Repeated contribution to the project
>>>>> Committers do not have to be coders, despite the title. A committer
>> is
>>>>> someone with recognised merit within the community. That's the long
>> and
>>>>> short of it. Naturally, being a software project, most committers are
>>>> also
>>>>> coders.
>>>>> But you can earn your commit bit by:
>>>>> * Doing QA work
>>>>> * Helping out on JIRA, doing triage
>>>>> * Helping people out on the mailing lists or on IRC
>>>>> * Contributing to the wiki or docs
>>>>> * Blogging, organising meet-ups, or giving presentations
>>>>> * Doing community out-reach or evangelism
>>>>> And, of course, submitting patches is good too... But is by no means
>>>>> required!
>>>>> So, please ask yourself:
>>>>> * Is there someone who's helped you out before, or who is doing a lot
>>> of
>>>>> good work, who isn't currently a committer? If so, please send an
>> email
>>>> to
>>>>> and tell us why you think they should be
>> a
>>>>> committer.
>>>>> * Are you put off because you don't know Erlang? Me too! I've not
>>> written
>>>>> a single line of Erlang for CouchDB, and I've been a committer for
>>> half a
>>>>> decade. See the next bit of this email...
>>>>> If you are interested in learning, we have the
>>>>> erlang@couchdb.apache.orglist. That is a dedicated resource for
>> people
>>>>> wanting to learn Erlang with
>>>>> CouchDB. The core devs are here to take you through the code, and get
>>> you
>>>>> started.
>>>>> But if you're not interested in learning Erlang, do any of the other
>>>> areas
>>>>> of contribution sound like your thing?
>>>>> Great! Let us know about it. Or better yet, just start doing it.
>> There
>>> is
>>>>> no need to check with anybody before you start doing something. Just
>>>> post a
>>>>> note to this list with an outline of what you propose to do, and then
>>>> start
>>>>> doing it. If people have a problem, they will speak up.
>>>>> This is how I try to operate. I get an idea about something which
>> would
>>>> be
>>>>> good for the project (like this email) and I just do it and hope it
>>>> doesn't
>>>>> upset anyone. There is no special status needed to do this. We can
>> all
>>> do
>>>>> it! The only thing a committer can do that a non-committer can't do
>> is
>>>>> check code directly into the repository.
>>>>> Everything else is wide open... So what are you waiting for? ;)
>>>>> Thanks,
>>>>> --
>>>>> NS
>> --
>> NS

  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message