AppStateESS/InternshipInventory

View on GitHub
README.md

Summary

Maintainability
Test Coverage
Internship Inventory
===================

[![Build Status](https://travis-ci.org/AppStateESS/InternshipInventory.svg?branch=master)](https://travis-ci.org/AppStateESS/InternshipInventory)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/AppStateESS/InternshipInventory/badges/quality-score.png?s=c90941c8179a4c726384b8b21bcd71536e7f1f36)](https://scrutinizer-ci.com/g/AppStateESS/InternshipInventory/)

Internship Inventory is a sleek, intunitive, and powerful web-application for tracking and approving student internships in a higher-education setting. It is created and maintained by the core team of [Electronic Student Services](http://ess.appstate.edu) at [Appalachian State University](http://www.appstate.edu) and other contributers.

## Purpose
Internship Inventory helps a Univeristy track internships campus-wide. We specifically care about:
* Where each student is located during their internship (because of [State Authorization](http://wcet.wiche.edu/focus-areas/policy-and-regulation/state-authorization) and in case of emergency)
* Who we should contact in case of emergency
* Generating and storing a valid contract for each internship, to protect all parties (Student, Hosts, and the University) in case of legal dispute.

We've realized other benefits too:
* We have great data for reporting and data mining!
* Internships tend to get approved more quickly, or we have good notes on what happened otherwise.
* Fewer students and faculty members skip steps in the approval process. We catch errors before they become problems.
* Cut costs by streamlining the approval process (less man-hours) and saving paper.

## Installation
Instructions on [how to install Internship Inventory](https://github.com/AppStateESS/InternshipInventory/wiki/Installation) can be found in the Wiki.

## Documentation
The project's [documentation is maintained in the wiki](https://github.com/AppStateESS/InternshipInventory/wiki). It's a bit sparse so far, but we're working on that.


## Bugs and feature requests
Have a bug or a feature request? Please first search for existing and closed issues. If your problem or idea has not addressed yet, [please open a new issue](https://github.com/AppStateEss/InternshipInventory/issues/new).


## Contributing
Community contributions are welcome. Please open a pull request.

By contributing your code, you agree to license your contribution under the [GNU GPL v3](LICENSE).

## Versioning
Internship Inventory is maintained under the Semantic Versioning guidelines. We'll adhere to these rules whenever possible.

Releases will be numbered with the format:

`<major>.<minor>.<patch>`

And constructed with the following guidelines:

- Breaking backward compatibility **bumps the major** while resetting minor and patch
- New additions without breaking backward compatibility **bumps the minor** while resetting the patch
- Bug fixes and misc changes **bumps only the patch**

For more information on SemVer, please visit <http://semver.org/>.

## Authors
- Jeremy Booker
- Jacob Pollard
- Jeff Tickle
- Robert Bost
- Micah Carter
- Eric Cambel
- Chris Detsch
- Cydney Caldwell

## Copyright and license
Code and documentation copyright 2008-2018 Appalachian State University. Code released under the [GNU GPL v3](LICENSE). Docs released under Creative Commons Attribution 4.0 International (CC BY 4.0).