Item-Catalog-Project

Project files for the Item Catalog Project in the Udacity Full Stack Nanodegree.

This project contains a database of comic book universe characters.

Set Up Instructions

Follow these instructions to set up the Vagrant Linux Environment and the Item Catalog Project

Prerequisite Resources

You will need the following Python resources for it to run:

• Python 2.7 or above (https://www.python.org/downloads/).
• Git (https://git-scm.com/downloads).
• Vagrant (https://www.vagrantup.com/).
• VirtualBox (https://www.virtualbox.org/wiki/Downloads).
• Sqlalchemy (https://www.sqlalchemy.org/download.html).

You will need the following other resources for it to run:

• Flask (http://flask.pocoo.org/).
• Httplib2 (https://pypi.python.org/pypi/httplib2/0.10.3).
• Oauth2client (https://pypi.python.org/pypi/oauth2client/).
• Web browser i.e. Chrome (https://www.google.com/chrome/)

Installation

• Install Git (https://git-scm.com/downloads) on the local machine
• Install Python 2.7 or above (https://www.python.org/downloads/) on the local machine
• Install VirtualBox (https://www.virtualbox.org/wiki/Downloads) on the local machine
• Install Vagrant (https://www.vagrantup.com/) on the local machine

Preparing the Virtual Machine

1. Use git clone https://github.com/petergns/item-catalog-project.git to clone this repository.
2. Navigate to the cloned repository using Git i.e. cd desktop/local-machine/vagrant
3. Run the command 'vagrant up' to download and install the linux operating system.
4. Run the command 'vagrant ssh' to log in to the virtual machine.
5. Install Flask (http://flask.pocoo.org/) with pip install Flask, if it is not installed already.
6. Install Sqlalchemy, Httplib2 and Oauth2client with sudo apt-get install, if they are not installed already.

Setup the Database

After the initial setup you can load the project files while connected to vagrant.

Navigate to cd item-catalog-project:

1. Run python requirements.txt
2. Run python database_setup.py
3. Run your web browser.

Contents of the Project

It uses python to establish a simple item-catalog database with an ability to add and edit new items.

The Item Catalog allows:

• Facebook or Google online login to edit add or delete content.
• Comic book characters to be added from comic book universes.
• New comic book universes to be added for characters.

Preparing the Project

In order to run the project you must have:

1. Run requirements.txt with the python requirements.txt command.
2. Run database_setup.py with the python database_setup.py command.
3. Checked universe_characters.py in a editor (some of which are featured below), if you would like to add more characters locally.
4. Run python universe_characters.py with the python universe_characters.py command.
5. Prepared your web browser to navigate to http://localhost:5000

Run the Project

1. Run the command python project.py in order to start the item-catalog.
2. Navigate to http://localhost:5000 on your web browser for access.

Useful Editors:

• Atom (https://atom.io/)
• Notepad++ (https://notepad-plus-plus.org/)
• Sublime Text (https://www.sublimetext.com/)

Catalog When Logged In

Adding a Comic Book Character Page

Author

petergns

Free Image Resource

1. https://pixabay.com/en/x-men-hero-marvel-comic-book-2640250/

Acknowledgments

Acknowledgments to Udacity for the resources that helped me develop this.