Giter VIP home page Giter VIP logo

todo-list-api's Introduction

Todo List Rails API

A simple todo list backend app that serves JSON data. Current functionality includes:

  • CRUD operations for a todo item with attributes for title, order, and completion (boolean).
  • RSpec test suite.
  • That's it! That's all the functionality for now. There may be more features added in the future.

Ruby Version

This API was written and tested with Ruby 2.3.0

System Dependencies

  • Rails 5.0.0.rc1
  • Puma for app server
  • Recommend using ActiveModel::Serializer instead of jbuilder. Just add to Gemfile:
gem 'active_model_serializers', '~> 0.10.0'

See Gemfile for other dependencies.

Getting Started

Configuration

This API uses PostgreSQL databases for the development, test, and production environments. See http://edgeguides.rubyonrails.org/configuring.html#configuring-a-database for configuring a different database.

Database creation and initialization

rake db:create db:migrate

Use

Run the development web server with bundle exec rails s

Common (RESTful) endpoints to use from your frontend application:

See a list of todos: GET /todos

See one todo: GET /todos/:id

Add a todo: POST /todos

How to run the test suite

bundle exec rspec spec/

Deployment instructions

This has not been tested yet. Will test in the future. Recommend using Heroku or Amazon Web Services (AWS).

todo-list-api's People

Contributors

dwhite96 avatar

Watchers

James Cloos 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.