Udacity Catalog Project

Table of Contents

• About this project
• Using Vagrant
• Using local environment
• Important Notes and Common Issues
• License

NOTE: For security reasons the original client_secret_google.json was removed after my project was approved on Udacity. It will remain in commit history, but the secret has expired in the Google API Console.

About this project

This project was made for Udacity Full-Stack Web Developer nanodegree. The goal is to provide a catalog application in Flask with CRUD, Authentication, and Authorization with Google, and a basic API endpoint to get the entire catalog of items.

Features

• Categories - CRUD
• Item - CRUD
• Google Authentication and Authorization
• CSRF

Getting Started

Start cloning this repository:

git clone https://github.com/klassmann/udacity-catalog.git

And choose between Vagrant or Local Environment.

Using Vagrant

Requirements

• Vagrant (Tested with Vagrant 2.0.2)
• VirtualBox (Tested with VirtualBox 5.2.4)

Setup Vagrant environment

Inside the project folder, use this command for setup the vagrant environment:

vagrant up

This command setups the vagrant and all the requirements for the project, when you log in Vagrant, you will have the correct Python version and all the requirements.txt installed.

Enter in Vagrant environment

After setup Vagrant environment, you can log in via SSH:

vagrant ssh

Change for the correct directory

cd /vagrant

Create the database

python database.py

Run the application

./run

Using local environment

Requirements

• Python 3

Start installing the requirements.txt

pip3 install -r requirements.txt

Create the database

python3 database.py

Run the application

./run

Use the following URL for open the application

http://localhost:5000

Important Notes and Common Issues

• If you are not using Vagrant, make sure of installing all the requirements in your environment.
• The database database.py need to be initialized before running the application app.py.
• The database is empty, so, you need to fill up it with your data.
• You have to open the address http://localhost:5000 in your browser because this is the only URL that Google Sign-In is authorized for run.

License

You can't use this project as your project for Udacity, but you can use for study purposes if you want.