Skip to content

Latest commit

 

History

History
76 lines (52 loc) · 2.42 KB

README.md

File metadata and controls

76 lines (52 loc) · 2.42 KB
Raw

Bookshelf Using Backbone Demo

This is a demo using Backbone JS to communicate with a RESTFUL book API.

The following fields represent a book:

  • a unique ID;
  • a required title;
  • a required author;
  • an optional format.

This application does not take into account any "types" of the above fields, but it is standard for the ID to be a numerically increasing integer; the rest should be strings allowed to be at least 255 characters.

The application uses a crude for of "long polling" when on the "#list" page to help the list stay up to date. Specifically, a timer using setInterval is set for 25-35 seconds (at random) after which a further request will be made to the server.

RESTFUL Server

Any server that conforms to a RESTFUL server as specified by Backbone JS may be used.

This happens to work well with:

The fields expected are:

  • id (not required for create)
  • title (required)
  • author (required)
  • format (optional)

The server SHOULD validate for required fields.

CONFIGURATION

Change the SERVICE_URL value in the webpack.config.js.

The value in the outer quotes will be substituted verbatim into the code, so to use http://www.books_api.com use '"http://www.books_api.com"' or "'http://www.books_api.com/'".

When deploying to a web server, any request must be resolved to the index.html or the non-hash based router will not work; a sample .htaccess is:

RewriteEngine on
RewriteCond %{REQUEST_FILENAME} !-d
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule . index.html

TODO

  • Write tests;
  • Handle backend errors more gracefully
    • Currently, some backend errors are simply serialised to the user (so they say technically valid but user unfriendly things)
  • Close the stack collapse on route change in mobile/small screen mode.

LICENSE

Copyright 2020 David S. Lloyd <jwickentower [at] gmail.com>.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.