PortfolioLife

The Curators project, Fall17/Spring18

Install Guide

Note that some steps in this install guide are dependent on others. For best results, perform the steps of this guide in order!

This guide assumes a basic competence with a command line tool like Terminal. For more information, click here.

Install Git.
Clone the repository to your machine. Use git clone https://github.com/theresaming/PortfolioLife.

Create an "S3 Compatible" object storage, such as Amazon S3, DigitalOcean Spaces, or Minio.
Fill out the details for the service in server/config.json.
Fill out your API key/secret in server/run-server.sh.

Install MySQL.
Create a MySQL user and database, and fill out the required details in server/config.json.

Install Go.
Open a terminal in server and type in go test -run TestMigration to setup the database with the preconfigured tables.
Run server/run-server.sh to start the API.

Install pip. On OSX, use sudo easy_install pip in Terminal.
Navigate to the flask directory in the project. On OSX, use cd PortfolioLife/flask.
Enter pip install -r requirements.txt in your console to download all Python dependencies.

Navigate to the flask directory in the project. On OSX, use cd PortfolioLife/flask.
Enter FLASK_APP=app.py flask run in your console to run the app.
Your console should output a local address (e.g. 123.0.0.1:8080) that you can paste as a URI in your web browser to view PortfolioLife.

Register for an account and login to the service. Users who have not registered are unable to use the service.
View photos and albums on an account by using the sidebar in the top left corner of the homepage.
Enlarge a photo for viewing by clicking on the photo on the homepage.
Upload photos to an account, by clicking on the "Upload Photos" button on the homepage.
Delete photos from an account, by clicking on the trash can button over a photo on the homepage. Deleted photos cannot be recovered!
Create albums on an account, by clicking on the "Create an Album" button on the homepage. Albums cannot be created without a title and must contain at least one picture.
Navigate to the photos homepage, the albums homepage, or the upload photos page using voice control. To activate voice control, click the button in the bottom left or press the spacebar. Wait for your spoken text to appear on screen before pressing the button again to submit your request.

Clicking the Delete button when viewing an album no longer redirects to the homepage.
Clicking the Edit button when viewing an album no longer redirects to the homepage.
Attempting to submit a voice request by clicking on the voice button no longer causes the feature to become unresponsive.

When viewing pictures on the album creation screen, a thin square border appears inside each photo.
Share-able links were not implemented.
Tag searching was not implemented.
Album editing was not implemented.
Mobile phone support was not implemented.
Liking a photo was not implemented.
Commenting on a photo was not implemented.
Voice control for photo deleting, photo tagging, search, album creation, and album deletion were not implemented.