IMPORTANT: OPEN SOURCE APPROVAL PENDING. ALL RIGHTS RESERVED BY UTS. PLEASE OPEN AN ISSUE BEFORE FORKING THIS CODE OR CONTACT @andrewresearch

tap-api

This is the server side code for a full stack: AWA, a web application for Academic Writing Analytics. The application was developed by the Connected Intelligence Centre, with the original software developed by Andrew Gibson.

This repo provides the REST API for the AWA client.

Quick Start

1. The steps to getting the tap-api running locally...

2. Connecting to http://localhost:8080/v1/health should return json...

{
  "message": "ok"
}

Documentation

For more detailed documentation on both TAP API and AWA client components, see the current docs.

Submitting bugs and suggestions

Please use GitHub issues to notify us of a bug or to request a new feature. Before adding a new request, please search the existing issues to see if there is one the same or similar to yours. If so, add a reaction (like 👍 or 👎) to the issue and post any additional relevant comments that will be helpful.

Contributing

Contributions to the code are welcome. Please read CONTRIBUTING for more information.

License

© University of Technology Sydney 2016-2017

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.