Skip to content

Latest commit

 

History

History
31 lines (27 loc) · 1.46 KB

README.md

File metadata and controls

31 lines (27 loc) · 1.46 KB
Raw

FLASK_SQL_API

A book reviews website were users can search for books, leave reviews and see the reviews by others. Using Goodreads API, ratings of the books will also be displayed. Finally, users can query also query for book details and rating through website's API.

Installation:

  • Clone/download the repository and move to the flask_sql_api folder
  • Install the required packages using:
pip install -r requirements.txt
  • In env.py file configure your secret key, database url and Goodreads API key. Database url follows the standard convention: [DB_TYPE]+[DB_CONNECTOR]://[USERNAME]:[PASSWORD]@[HOST]:[PORT]/[DB_NAME]. You can get the Goodreads API key from here.
  • Now, run the file using:
set FLASK_DEBUG=1
set FLASK_ENV=development
set FLASK_APP=run.py
python -m flask run
  • On moving to the provided url, you will be able to see the login page: alt text
  • Quit the server and import the data using:
python import.py
  • Run the file, register, login and you will be able to see the dashboard: alt text

You can now search books, view ratings, post reviews and query for a book's data using the "url_of_website/api/book_isbn_number" route.