Skip to content
Snippets Groups Projects
Select Git revision
8 results Searching

lets-gone

  • Clone with SSH
  • Clone with HTTPS
  • Bastien DUMONT's avatar
    Bastien DUMONT authored
    generated from commit 3864cd03
    0452b590
    History

    Lets gone

    What's Lets gone?

    Découvrez et évaluez votre autonomie dans les différents aspects de la vie.

    Documentation métier

    • Axes
      • Domaines
        • Actions

    Run the app

    docker run -ti --rm -p 8080:8080 -p 5984:5984 -p 8025:8025 -e COZY_DISABLE_CSP=1 -v $(pwd)/lets-gone/build:/data/cozy-app/letsgone -v ~/cozy.yaml:/etc/cozy/cozy.yaml cozy/cozy-app-dev
    
    cd lets-gone
    yarn start

    Alpha install

    ./cozy-stack.sh apps install letsgone --domain john.cozy.self-data.alpha.grandlyon.com git://forge.grandlyon.com/web-et-numerique/factory/proof-of-concept/lets-gone.git#build-dev

    Models

    The Cozy datastore stores documents, which can be seen as JSON objects. A doctype is simply a declaration of the fields in a given JSON object, to store similar objects in an homogeneous fashion.

    Cozy ships a built-in list of doctypes for representation of most of the common documents (Bills, Contacts, Files, ...).

    Whenever your app needs to use a given doctype, you should:

    • Check if this is a standard doctype defined in Cozy itself. If this is the case, you should add a model declaration in your app containing at least the fields listed in the main fields list for this doctype. Note that you can extend the Cozy-provided doctype with your own customs fields. This is typically what is done in Konnectors for the Bill doctype.
    • If no standards doctypes fit your needs, you should define your own doctype in your app. In this case, you do not have to put any field you want in your model, but you should crosscheck other cozy apps to try to homogeneize the names of your fields, so that your doctype data could be reused by other apps. This is typically the case for the Konnector doctype in Konnectors.

    Open a Pull-Request

    If you want to work on Lets gone and submit code modifications, feel free to open pull-requests! See the contributing guide for more information about how to properly open pull-requests.

    Community

    What's Cozy?

    Cozy is a platform that brings all your web services in the same private space. With it, your webapps and your devices can share data easily, providing you with a new experience. You can install Cozy on your own hardware where no one's tracking you.

    License

    Lets gone is developed by bastiendmt and distributed under the AGPL v3 license.