GitXplorerGitXplorer
R

pot-of-quotes-app

public
1 stars
1 forks
2 issues

Commits

List of commits on branch master.
Verified
b2d62e193cae3f72563f968912bce614e861d574

Merge pull request #1 from johntellsall/zap-huge-files

RRafaelDavisH committed 7 years ago
Unverified
dc7594fbe80deae00e3aef79cdc724afdd57867b

as a dev I dont want to clone huge files I cant use

jjohntellsall committed 7 years ago
Unverified
fed2e72705f1787c5962d594b41b7fb072d12846

fix: primary GitHub email added to .gitconfig

RRafaelDavisH committed 7 years ago
Unverified
e2469829ee093c89cdc9aa0c99af88048e65a345

style: re-formatting - placing Authentication check before implementing

RRafaelDavisH committed 7 years ago
Unverified
d542cbfba4d7cc65d05baee13fd55c32aaa26042

chore: Add Docstrings to 'application.py' and 'database_setup_app.py', made it PEP 8 complaint.

RRafaelDavisH committed 7 years ago
Unverified
64fd3d126d10be449fa5e4edee2eb30cbd6bd36e

fix: Remove .. to ignore folders

RRafaelDavisH committed 7 years ago

README

The README file for this repository.

Pot of Quotes

"Wise men learn more from fools than fools from wise men" – Cato

A web application that provides a list of quotes within a variety of categories as well provides a user registration and authentication system. This application uses persistent data storage to create a RESTful web application that allows users to perform Read, Create, Update, and Delete operations.

The registration and authentication its done using OAuth 2.0 to access Google API and utilize Google Sign-In. The application also provides three secured JSON Endpoints.

Implementation

  • Python 2.7
  • Jinja2
  • Flask
  • SQLAlchemy
  • JSON
  • OAuth2 authorization protocol
  • Google API
  • Bootstrap

Installation

To run, develop and test the application locally the following are needed.

  1. Install Vagrant and Virtual Box
  2. Clone pot-of-quotes-app
  3. Launch the Vagrant VM
    • vagrant up
    • vagrant ssh
    • cd /vagrant
  4. Work on the Flask application locally in the vagrant directory
  5. Run application within the VM.
    • python application.py
  6. Access and test application by visiting http://localhost:8000 locally.

JSON Endpoints

Endpoint /api/v1/categories Returns a list of all the categories.

Endpoint /api/v1/categories/quotes Returns a list of all the quotes under a category.

Endpoint /api/v1/categories/quotes/1 Returns a single quote under a category.

Restful Endpoints

READ for Categories

/categories/

CRUD for Quotes

/categories/<string:category_name>/quotes

/categories/<string:category_name>/quotes/<int:quote_id>

/categories/<string:category_name>/quotes/new

/categories/<string:category_name>/quotes/<int:quote_id>/edit

/categories/<string:category_name>/quotes/<int:quote_id>/delete

Sign-In with Google

'/login'

TODO

  • Sign Up
  • like functionality
  • Ability to add background images
  • Share functionality

ISSUES with

www.potofquotes.pythonanywhere.com

  • Sign In not working
  • Secret Key missing
  • Broken "newQuote" link