/LRMDB

Primary LanguageJavaScript

La Reunion Maintenance Database

(c) 2014 Gatlin Johnson gatlin@niltag.net

  1. LICENSE

        DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
                    Version 2, December 2004

 Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>

 Everyone is permitted to copy and distribute verbatim or modified
 copies of this license document, and changing it is allowed as long
 as the name is changed.

            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

  0. You just DO WHAT THE FUCK YOU WANT TO.
  1. Synopsis

This is a simple web frontend to the maintenance database at La Reunion Cooperative.

  1. App specifications

The client-side code is written with AngularJS and Yeoman. If you are not familiar with either of those two projects, follow the links and then come back here. The client side code is intended to be completely divorced from the server code so that perhaps the server code can be repurposed in the future.

For example, perhaps we want to trigger new issues in the database via text message from Google Voice, or to grant access to Trello or some other status app, etc. The REST service can be called by any HTTP client.

When serving locally in development mode, the client side code communicates with a fake HTTP backend and exchanges fake testing data. You may find the file controlling this at app/scripts/dev-mocks.js.

The REST service is written with the Django Rest Framework. That project is located in the server directory.

To update the client side code: In your terminal, run grunt --force to create a dist/ directory. This should be copied or symlinked to server/maint/static/maint.

  1. Bugs? Questions? Ideas?

Please use the Issues feature on the Github page or send an email to gatlin@niltag.net.

If you have any brilliant ideas, please feel free to submit a pull request.

  1. Apologies

Yeah yeah, I know, Python/Django. I wanted to choose something lots of people know and which is documented well. Within those requirements I know Python/Django the best. Any choice I made was going to have hideous flaws so we will all just have to learn to cope.