DDB Help Desk Readme

README.md

[DDB Help Desk]![Build Status]

description

ddb help desk is a web application for managing ddb institutions and its users.

getting started

download

Clone the repo, git clone https://github.com/Deutsche-Digitale-Bibliothek/ddb-helpdesk, or download the latest release.

build

we are using yeoman

run

$ cd app
$ python -m SimpleHTTPServer 3004

if you are using yeoman

$ yeoman server

open web browser: http://localhost:3004

usage

TODO

examples

TODO

tips

TODO

bug tracker

Have a bug? Please create an issue [https://jira.deutsche-digitale-bibliothek.de/browse/DDBEXTRA], Component: DDB HelpDesk that conforms with necolas's guidelines.

developers

IDE / Text Editor

Eclipse

If you are using eclipse, please refer to Web Application Developement with Eclipse

Bootstrap

• Create a JavaScript project

  CTRL-3 > new javascript > 'New JavaScript Project'

• choose a project name, for example: ddb-hdif
• check 'create project from exiting source' (ALT + x)
• choose the cloned project, i.e., ddb-hdif
• click finish
• make sure you configure
  • HTML Tidy
  • JSHint
  • JavaScript Formmater and Code Clean Up before you start developing.
  • Google Closure Linter

REST service access

you need a VPN access to the FIZ Karlsruhe development server. Ask Frank Schwichtenberg, if you need one.

technology

• html
• css
• javascript
• backbone.js

design

TODO

supported browsers

TODO

models

• organization
• person

collections

• organization-collection
• person-collection

view

login

TODO

edit

TODO

breadcrump

TODO

search

TODO

routes

TODO

first iteration

TODO

rest service

dev service URI: http://141.66.8.240:8080/aas/ (FIZ KA/IEE VPN is needed)

implementation

TODO

• yeoman.io
• backbone.js

directory structure

.
|-Mock
|-app
|---components
|---scripts
|-----collections
|-----helpers
|-----models
|-----routes
|-----templates
|-----vendor
|-----views
|---styles
|-test
|---lib
|-----mocha-1.2.2
|---runner

contributing

TODO

• Code Style Please follow our HTML, CSS and JavaScript style guide.

authors

** Frank Schwichtenberg **

• https://github.com/fschwic

** Frank Asseg **

• https://github.com/fasseg

** Christian Herlambang **

• http://gplus.to/crh
• https://github.com/crh

copyright and license

Copyright 2012 FIZ Karlsruhe.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or 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.