uradn / ami

AMI: Access My Info

Access My Info

Access my Info (AMI) is a web application that helps people to create justified requests for copies of their personal information from service providers. AMI is a step-by-step wizard that results in the generation of a personalized formal letter requesting access to the information a provider stores and utilizes about a person. The letter can be saved as a PDF, printed, and mailed through the post, or where available, directly emailed to a company’s privacy officer.

To start with, the application is focused on the PIPEDA framework for requesting access to personal information. This law forms the basis of the formal request. The longer term goal of AMI is to expand this functionality to accommodate requests justified under different laws or contracts around the world. Please contact Andrew Hilts if you are interested in contributing to the project.

The application is powered by JavaScript and runs entirely within the browser, including the creation of the PDF letter. It is designed so that no personal information is ever sent to the server. It is built using Angular JS, Bootstrap, JSPDF, Font Awesome, Yeoman.

Set up

To set up AMI for development on your system:

1. Ensure that you have all dependencies installed. You will need to install Yeoman, grunt, bower, and their dependencies (node.js & npm primarily).
2. In a terminal, Clone the repository and navigate into the root directory.
3. Run npm install to install the node components needed for the build environment
4. Run bower install to install the frontend components that AMI relies upon.
5. Then, run grunt serve to get a live development server running at localhost:9000
6. Open up the app source code in your text editor of choice. Most editing will need to be done within the app/ directory
7. Once a file is saved, the server will reload the app in your browser, and changes can be previewed.

Deployment

1. Once you want to take the app to production, run grunt build from the app root directory
2. This will create / update the dist/ directory, which is a production-ready compilation of the app.
3. Navigate to the dist/ directory and set up a git remote server to push to or simply upload the directory via FTP or your method of choice.

License

Copyright 2014 Digital Stewardship Initiative Contributors (University of Toronto and Fort Effect Company Corporation)

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this software 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.