• Summary
• Features
• How to run
• Extras
• References

This application provides a list of categories and items. Users can register to be able to add, modify and delete items and categories. Non registered users will be able to view categories and items. Items and Categories can also be retrieved via a JSON API.

• Sign up system

• Sign in using Google, Facebook, or your locally created accout

• Create, Read or Delete categories

• Create, Read, Update or Delete items

• Associate items to categories

• View items created by a user

• JSON API endpoints:

  http://localhost:5000/categories/all/json # returns a json object of all categories http://localhost:5000/items/all/json # returns a json object of all items http://localhost:5000/items/int:item_id/json # returns a json object of a specific item

• Install Vagrant and VirtualBox

• Navigate to your vagrant directory

• Clone this repository within your vagrant directory git clone https://github.com/younessassassi/fullstack-nanodegree-catalog.git catalog

• Launch the Vagrant VM

• login to the linux box and cd to the vagrant folder

$ vagrant up
$ vagrant ssh
$ cd /vagrant/catalog    # navigate to the poject directory 'cd vagrant/path/to/project/folder'

1. login to the linux box

$ vagrant up
$ vagrant ssh
$ sudo pip install virtualenvwrapper
$ cd ~
$ nano .profile

2. Add the following to the .profile

# Virtualenvwrapper setup
export PROJECT_HOME=$HOME/vagrant
source /usr/local/bin/virtualenvwrapper.sh

3. Save and close the file
4. Navigate to the project directory

$ cd /vagrant/catalog
$ mkvirtualenv catalog
$ setvirtualenvproject

5. Now from any project or directory in the linux you can jump to your project workspace by typing:

$ workon catalog

6. when you are done deactivate the project by typing:

$ deactivate

$ workon catalog
$ pip install -r requirements.txt

As the app uses Google for authentication, the next step you have to obtain a client id and client secret from Google:

1. Go to the Google Developer Console.
2. Create a new project.
3. Get the App ID & App Secret
4. Copy the client id and client secret and replace the GOOGLE_LOGIN_CLIENT_ID and GOOGLE_LOGIN_CLIENT_SECRET in config.py file located in catalog/catolog/config.py

As the app uses also Facebook for authentication, the next step you have to obtain a client id and client secret from Facebook:

1. Go to the Facebook Developer.
2. Create a new app (www - website).
3. Get the App ID & App Secret
4. Copy the client id and client secret and replace the FACEBOOK_LOGIN_CLIENT_ID and FACEBOOK_LOGIN_CLIENT_SECRET in config.py file located in catalog/catolog/config.py

$ python manage.py db init                  #initialize migration files
$ python manage.py db migrate -m "initial"  #initialize database with a title
$ python manage.py db upgrade               #create tables

$ python manage.py runserver

$ vagrant halt

$ vagrant destroy

$ python manage.py db init                  #initialize migration files
$ python manage.py db migrate -m "initial"  #initialize database with a title
$ python manage.py db upgrade               #create tables
$ python manage.py db migrate -m "tags"     #for sample db migration when a db change is introduced
$ python manage.py db upgrade               #to run the migration

1. Insert these lines which act as a breakpoint in your code:

import pdb
pdb.set_trace()

2. Run the application until it hits the breakpoint
3. Use these commands in the python console

'l' #to list the context of breakpoint
'c' #to continue
'n' #to move forward
's' #to step into
'r' #run until the current function returns
'h' #for help
'q' #for quit
'w' #to print the call stack
'b' #filename:line number

1- nosetests will detect and run the available tests within the project. A temporary database will be created and destroyed in the process which will not impact the dev and prod databses

nosetests

1- to switch between, dev, test and prod type the following:

$ export CATALOG_ENV=dev   # for the dev environment
$ export CATALOG_ENV=test  # for the test environment
$ export CATALOG_ENV=prod  # for the prod environment

• Pluralsight Flask course
• OAuth Authentication with Flask blog