pdurbin / addressbookmvc Goto Github PK

View Code? Open in Web Editor NEW

4.0 4.0 5.0 849 KB

http://todomvc.com but for the back end

addressbookmvc's Introduction

Goal

Create various implementations of a minimally simple addressbook service

Why?

To ease comparison between different languages/frameworks/approaches
To demonstrate how to use the various languages/frameworks/approaches

The Original Idea

http://todomvc.com but using server-side technologies.

have a database with a table with names and phone numbers (and probably a surrogate key)
the application should list all the entries (optionally paged)
you should be able to add, edit and delete an entry
each entry has 2 fields: name and phone number
any other features are optional

Implementation Guidelines

General

Go for clarity and simplicity which should ease comparison and improve the pedagogical win.
Err on the side of excessive commenting.
Implementations MUST include persistence.
Implementations SHOULD behave as described in the API doc below, whether it provides an actual API service or merely outputs HTML directly.

Contacts

A contact is completely described as:

{
  "id":   <integer>,
  "name": "<string>",
  "phone": "<string>"
}

SQL

If you choose to use an SQL-based persistence, here is some example DDL:

CREATE TABLE contacts (
id INTEGER NOT NULL PRIMARY UNIQUE AUTOINCREMENT,
name TEXT NOT NULL,
phone TEXT NOT NULL
);

The above is SQLite compatible syntax.

File

If you choose to use file-based persistence, please use OS-independent path handling/access where possible.

API

URI	Responses1	HTTP Method (Verb) and Parameters	Description
/contacts	200, 204	GET	list all contacts
/contact	201, 400	POST with JSON representation of new contact	create a new contact
/contact/<id>	200, 404	GET	display a specific contact
/contact/<id>	200, 400, 404	PUT with JSON representation of new data	update a specific contact
/contact/<id>	204, 404	DELETE	delete a specific contact

See RFC7231 Section 6 for details on HTTP/1.1 Status Codes.
See RFC7231 Section 4.3 for details on HTTP/1.1 Method Definitions.

addressbookmvc's People

Contributors

Stargazers

Watchers

Forkers

zmughal gitter-badger aditsu dhutty meatherly

addressbookmvc's Issues

Java EE example

I have some experience in Java EE and JSF so I've contributed an example. The idea with my example is to use "stock" Java EE and JSF without any addons such as Primefaces or PrettyFaces.

To do:

use PosgreSQL rather than Derby

I've been working on a Django example, not that I'm particularly good at Django. I'm following https://docs.djangoproject.com/en/1.8/intro/tutorial01/ but I'll probably hit up some experts for advice. :)

add JSON output to wicket example

@aditsu and I have been talking at http://irclog.greptilian.com/friendlyjava/2019-03-03 and he provided a patch to add JSON output to his wicket example:

1YC5H1K.txt

VRaptor 4 example

https://github.com/caelum/vraptor4/

Phoenix example

After hearing @chrismccord on https://changelog.com/147/ , chatting with him a bit and seeing a nice sample app by @meatherly at http://meatherly.github.io/2015/05/04/phoenixlivelikeawarrior/ I'm thinking it would be interesting to have a Phoenix example.

Create a spec

If we create specification, it would make it easier to create examples in new languages/frameworks (and test them).

This could be done iteratively with several levels depending on the time/effort available:

Broad, qualitative description of what the app should do
Complete ReST API docs
Test suite(s) to test functionality (unit testing would of course, be in the domain of the developer of each example stack).

addressbookmvc could be renamed to something better

Please use http://www.tricider.com/brainstorming/35DVEKere5x to suggest ideas. See #4 for the spec discussion.

Is there already a TodoMVC for back end (server-side) technologies?

http://todomvc.com is a fantastic resource for helping developers evaluate Javascript MVC frameworks. Rather that reading people's opinions you can look at actual code and play with demo apps.

Is there already a repository of various examples of implementing the same simple demo web application in back end or server-side technologies? Creating an address book webapp was suggested, which sounds fine, so that's what this repo is about: rending HTML on the server-side.

If something like this already exists, however, please link to it in a comment.

circuits.web example

@prologic sounds interested in contributing a circuits.web ( http://circuitsweb.com ) example: http://irclog.greptilian.com/sourcefu/2015-03-29#i_105472

Ozark (MVC 1.0) example

In 8c2678d I stubbed out an example using Ozark (MVC 1.0): https://ozark.java.net

I'm not done, however. The biggest problem I'm having is that I'm not sure how to populate the home page with the list contacts (people in the address book).

I'm able to list all contacts by hitting a URL under "resources" such as http://localhost:8080/ozarkaddressbook-1.0-SNAPSHOT/resources/contacts (which is handled by https://github.com/pdurbin/addressbookmvc/blob/8c2678de54e23cdd32b914967ce3e8930495f272/examples/ozark/src/main/java/com/greptilian/addressbookmvc/ozark/PeopleController.java ) but it's not clear to me how I would list the contacts at the home page at http://localhost:8080/ozarkaddressbook-1.0-SNAPSHOT/ (which is https://github.com/pdurbin/addressbookmvc/blob/8c2678de54e23cdd32b914967ce3e8930495f272/examples/ozark/src/main/webapp/index.html ).