https://github.com/pinx/fulcrum

Elixir library for the Fulcrum API
https://github.com/pinx/fulcrum

Last synced: about 2 months ago
JSON representation

Elixir library for the Fulcrum API

• Host: GitHub
• URL: https://github.com/pinx/fulcrum
• Owner: pinx
• License: mit
• Created: 2016-01-11T18:32:58.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2016-02-18T11:34:29.000Z (almost 9 years ago)
• Last Synced: 2024-10-29T08:42:39.965Z (about 2 months ago)
• Language: Elixir
• Size: 56.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Fulcrum

Fulcrum library for Elixir.

The aim is to present the Fulcrum API as a replacement for the Ecto Repo.

So, instead of Repo.all(Form), you can write Fulcrum.all(Form). In this way, you only have to make minor changes to your controllers, to work with Fulcrum.

## Installation

Add fulcrum to your list of dependencies in `mix.exs`:

```elixir

def deps do

  [{:fulcrum, "~> 0.0.1"}]

end

```

Ensure fulcrum is started before your application:

```elixir

def application do

  [applications: [:fulcrum]]

end

```

Add your Fulcrum api-key to your config file

```elixir

use Mix.Config

  config :fulcrum,

    api_key: ""

```

## Usage

The following resources are available (checked ones have been implemented):

  - [ ] Users (only "all")

  - [x] Memberships (only "all")

  - [x] Forms

  - [x] FormMemberships (only "insert!")

  - [x] Records

  - [ ] Choice Lists

  - [ ] Classification Sets

  - [ ] Change Sets (coming from mobile device)

The following functions are implemented:

  - [x] all/1

  - [x] get!/1

  - [ ] get/1

  - [x] insert!/1

  - [ ] insert/1

  - [x] update!/1

  - [ ] update/1

  - [x] delete!/1

  - [x] delete!/2

  - [ ] delete/1

## Credits

[Fabriquartz] (https://github.com/Fabriquartz)