Go to file
Etienne Baque 936accc25a Fixed navigation submission form 2017-01-24 19:48:20 -05:00
app Fixed navigation submission form 2017-01-24 19:48:20 -05:00
bin Wrote first cucumber tests 2016-09-11 21:24:19 -04:00
config Refactored item search and refine categories 2017-01-13 23:47:40 -05:00
db Fixed setup pages 2017-01-02 15:26:52 -05:00
features Fixed cucumber tests 2016-12-31 19:55:41 -05:00
lib Added results page dynamically 2017-01-08 22:33:03 -05:00
log Imported Madloba project from private repository 2015-03-05 19:22:05 +04:00
public Removed assets added accidentaly 2016-10-11 18:58:54 -04:00
script Wrote first cucumber tests 2016-09-11 21:24:19 -04:00
spec Fixed Rspec config 2017-01-01 23:37:05 -05:00
vendor/assets Improved search result page 2017-01-15 22:42:11 -05:00
.codeclimate.yml Added Code Climate config files 2016-10-02 00:25:46 -04:00
.csslintrc Added Code Climate config files 2016-10-02 00:25:46 -04:00
.eslintignore Added Code Climate config files 2016-10-02 00:25:46 -04:00
.eslintrc Added Code Climate config files 2016-10-02 00:25:46 -04:00
.gitignore Added Haml and Awesome_print gems - ready to convert erb into haml 2016-02-06 16:21:05 -05:00
.irbrc Added Haml and Awesome_print gems - ready to convert erb into haml 2016-02-06 16:21:05 -05:00
.rspec Fixed Rspec config 2017-01-01 23:37:05 -05:00
.rubocop.yml Added Code Climate config files 2016-10-02 00:25:46 -04:00
.ruby-version Updated gems 2016-12-26 10:11:11 -05:00
.travis.yml reverted change on travis config file 2017-01-01 23:23:22 -05:00
Capfile Fixed ruby version for capistrano 2017-01-02 18:17:12 -05:00
Gemfile Implemented Bootstrap tags input plug-in 2016-12-28 21:23:05 -05:00
Gemfile.lock Implemented Bootstrap tags input plug-in 2016-12-28 21:23:05 -05:00
LICENSE Initial commit 2014-12-28 14:12:37 +01:00
Procfile Imported Madloba project from private repository 2015-03-05 19:22:05 +04:00
README.md Fixed ruby version for capistrano 2017-01-02 18:17:12 -05:00
Rakefile Imported Madloba project from private repository 2015-03-05 19:22:05 +04:00
coffeelint.json Added Code Climate config files 2016-10-02 00:25:46 -04:00
config.ru Removed use of websockets 2017-01-08 17:00:34 -05:00

README.md

Madloba

Build Status Code Climate

Madloba (beta) is a free, open-source solution that connects people who have things to exchange.

Each Madloba website uses a map that allows users to visualize at a glance what their neighbours have to give away or what they are looking for.

More information on madloba.org.

Deployment

To deploy your Madloba instance, follow the steps in the installation guide.

Development

If you want run Madloba on your local machine, follow these steps:

  1. Make sure you have these prerequisites installed:
  1. Run the following commands:
    $ git clone git@github.com:etiennebaque/madloba.git
    $ cd madloba && bundle install
    
  2. Database config: update the settings of your development database, by doing the following:
  • Make a copy of /config/app_environment_variables.rb.sample and name it /config/app_environment_variables.rb.
  • In /config/app_environment_variables.rb, set your database credentials.
  1. Once this is done, create your local database by running:
    $ bundle exec rake db:setup
    
  2. That's it, youre good to go! Start your local server:
    $ rails s
    

Used gems

This project uses the following main gems:

  • Devise (authentication)
  • Pundit (authorization)
  • Faye Websocket (websockets)
  • Capistrano (deployment)
  • Delayed job (queue)
  • Carrierwave (file upload) and Carrierwave-backgrounder (file processing)
  • Fog (cloud storage on Amazon S3)
  • Dalli (cache)
  • RSpec and Factory girl (testing)

Demo

Feel free to give Madloba a try at demo.madloba.org. Instructions about this demo can be found here.

Contribution

  1. Fork the Madloba project.
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request.

License

Madloba is an Open Source Software released under the GNU Geneal Public License - V2.