Skip to content

Commit

Permalink
changes in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
Guillaume Barillot committed Oct 30, 2012
1 parent bfa0927 commit c1c64f8
Showing 1 changed file with 8 additions and 41 deletions.
49 changes: 8 additions & 41 deletions README.md
@@ -1,8 +1,7 @@
The Refuge : simple social networking for cool coworking places
La cabane : simple social networking for cool coworking places
===========
[![Travis](https://secure.travis-ci.org/la-cordee/refuge.png)](http://travis-ci.org/la-cordee/refuge)

The Refuge is a Ruby on Rails application that aims to help coworkers working with each other, and knowning each other better.
La Cabane is a Ruby on Rails application that aims to help coworkers working with each other, and knowning each other better.

What it does :

Expand All @@ -16,55 +15,23 @@ What it does :
* Sharing Google agendas
* Checking meeting rooms occupation rate and disponibility
* Sending e-mail across members
* Headlines and news. Mmmh, yes, you can call it a Blog (with RSS output)
* You can also manage multiples coworking places at the same time !

Extra-bonus feature :

* Wooohoo... you can also manage multiples coworking places at the same time !

It is NOT a one-more-kinda-social-app for the masses. The refuge doesn't have any internal messaging system, and your account must be first created by one of the admin user.
On the other hand, The Refuge tends to fit with non-profit organisations and coworking places who need to manage and deal with dozains of members who want to
It is not a one-more-kinda-social-app for the masses. By design, La Cabane doesn't have any internal messaging system, and your account must be first created by one of the admin user.
On the other hand, La Cabane tends to fit with non-profit organisations and coworking places who need to manage and deal with dozains of members who want to
share their profiles and know about each others' inside a private, secure yet Web accessible portal.

Installation
----------------

Clone or Fork the repo :

`git clone git@github.com:la-cordee/refuge.git && cd refuge`

Run the bootstrap script to check that you have all dependencies installed and set up a development environment:

`script/bootstrap`

Done !

Note
-----
You may also check your Mail server configuration, since the Refuge sends E-Mail across members and on account creations. Nonetheless, it is not required for application bootstrap.

Usage
-----
This is work in prgress stuff, but you can clone the repo and setup a dev. DB...

Naviguate to your app's URL, then log in using the default account :

*email : admin@refuge.com*

*password : 123456*

Once logged in, you should change your password and personnal informations by visiting your own account.

By design, there is no real dedicated "admin interface". Each user can edit its own account by visiting its profile, and admins can edit all users.
As an admin, you also have access to the admin top tab, which allows you to customize the default avatar, create/update/delete places, manage surveys...

TODO
------

* Translations (Actually French and English are supported but PR are welcome !)
* Tests, tests, tests


Author
------
* Some Tests in the admn side

* Guillaume Barillot (http://www.guillaume-barillot.com), with the highly appreciated help of 21croissants in the projet management.

0 comments on commit c1c64f8

Please sign in to comment.