GitXplorerGitXplorer
R

pot-of-quotes-app

public
1 stars
1 forks
2 issues

Commits

List of commits on branch master.
Unverified
d9fc4f04f84bebe76d1b5f8b82d4cacb51cb5d46

fix: Add ! before folder to ignore

RRafaelDavisH committed 7 years ago
Unverified
7130abbc6b79748bf8bf93d72a6c5908ca7ffec6

Work on .gitignore to properly remove folders

RRafaelDavisH committed 7 years ago
Unverified
86fc37a976a78957c4fd4de85b5ed30f6ef625f7

Add some folder to .gitignore

RRafaelDavisH committed 7 years ago
Unverified
9fa159a7e53070b4b1244b06b5e033b1d468c382

Remove all files that are in the .gitignore

RRafaelDavisH committed 7 years ago
Unverified
63f2126c910d515cdd8808da79f84f91c54e8c1e

Remove all files that are in the .gitignore

RRafaelDavisH committed 7 years ago
Unverified
9b68c6403204df28e5df96dbe1944e61dad51360

Add Docstrings and make it PEP8 compliant

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