Giter Club home page Giter Club logo

to_do's Introduction

ToDo

Simple JSON API (using RESTful principles) that helps users manage tasks.

This version represents an admin view—tasks are defined in a CSV file, and the interface does not allow users to modify or add tasks.

Development

This project is written in Elixir. In order to build and run it, you will need to install Elixir. On Mac OS X, if you have homebrew installed, this can be done with:

brew install elixir

To load dependencies and compile the project:

mix deps.get
mix compile

To Run Tests

Run tests from the root directory with:

mix test

Running Locally

To launch the application along with an interactive shell:

iex -S mix

This should expose endpoints such as:

curl http://127.0.0.1:8080/users

API

The following endpoints are supported.

GET /users

Returns a list of all users.

Example:

curl http://127.0.0.1:8080/users

[ "alice", "bob", "claire" ]

GET /users/<user-id>

Returns a list of all tasks for the user.

Example:

curl http://127.0.0.1:8080/users/alice

{ "2016-09-09": [ "Change light bulb" ]
, "2016-09-08": [ "Buy some milk" ]
}

GET /users/<user-id>/tasks/<date>

Returns a list of all tasks for the user on the given date. Dates are represented in ISO 8601 date format (YYYY-MM-DD).

Example:

curl http://127.0.0.1:8080/users/claire/tasks/2016-09-10

[ "Clean room", "Go to the movies" ]

to_do's People

Contributors

defndaines avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.