Skip to content

Latest commit

 

History

History
72 lines (47 loc) · 3.08 KB

README.md

File metadata and controls

72 lines (47 loc) · 3.08 KB
Raw

Créons la Coop (CLAC) 🌾

What's this app for:

An association ('Créons la Coop') located north of France has created a food co-op, inspired by Park Slope Food Coop. Members of this co-op need to use more efficient means of communication than just e-mail and phone. Members buy products from productors, and sell these products to themselves. Each member must give at least 3 hours/month of their time to the association.

Details

Why?

  • Communicate quickly, easily find relevant info, facilitate organisation

How?

  • Members list with contact infos, by workgroup
  • Productors list with contact infos, products lists, quick geographic lookup
  • Activities calendar: see in a glance what needs to be done in the co-op
  • Forum to chat and get involved in decisions that need to be made
  • General announcements and common administrative documents share
  • Admin interface to manage resources in bulk

Features

  • Admin interface with ActiveAdmin, config via app/admin

Members

  • Authentication with Devise, member registration by invitaion only
  • CRUD on Member model
  • Privilege level set on the role attribute
  • Authorizations policies managed with Pundit

Produtors

  • CRUD on Produtor model

Activities

  • CRUD on Mission model (will probably be renamed in the future)
  • Calendar on index page with FullCalendar
  • Event Recurrence management with IceCube
  • Member subscription on events, with member count validations

Share

  • CRUD on Info model
  • Basic blog interface
  • Administrative documents upload set up with S3
  • Forum set with Thredded engine

Theme

  • Currently using Boomerang bootstrap theme
  • If you want to use this app as it is, you must buy a Boomerang license. Otherwise, set up your own theme by deleting Boomerang resources from /vendor and asset pipeline. Libs and asset pipeline will be cleaned soon to facilitate this

Versions:

  • Ruby => 2.5.1
  • Rails => 5.2.3

Contributions / set up

Any contributions would be very welcome. See projects tab if something interests you, or post an issue with a feature suggestion that you think would be useful considering the scope of this kind of app.

To get started:

  • Choose one:
    • Docker Compose setup : $ docker-compose up to setup containers, DB, and launch server on localhost:3000. $ docker-compose down to unmount. You might need administrative privileges.
    • Manual setup: You need to install PostgreSQL. Then $ rails db:setup to create + migrate + seed DB, then $ rails server launch server on localhost:3000.
  • The main branch is development, start your branch from there.
  • Launch $ npm install if you want to setup git hooks via package.json