You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

2.7 KiB

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, you’re 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.