Chess Reads, Item Catalog Application

• Intro
• Implementation
• Dependencies
• How to run it

Intro

The task was to develop an application that provided a list of items within a variety of categories as well as provided a user registration and authentication system, giving registered users the ability to post, edit and delete their own items.

I came up with the catalog of chess books. Non-registered users can access all the categories and books in the catalog in read-only mode. Registered users can add new books to existing categories as well as create own categories. They can then update and delete only categories they created and books they added.

Implementation of the project

• db_setup.py sets up the database and classes >>> model;
• templates and static are responsible for the presentation >>> view;
• app.py contains main logic of the app >>> controller;

Dependencies (built with)

• Python
• Flask
• PostgreSQL
• SQLAlchemy
• oauth2client
• httplib2
• HTML
• CSS
• JavaScript
• jQuery

How to run it

1. Make sure Python is installed on your computer. Otherwise, download and install Python 3.7.2 from the download page (see Dependencies above);
2. Download and install Oracle VM Virtual Box; make sure the CPU Virtualization is enabled;
3. Download and install Vagrant;
4. Download and unzip VM configuration files;
5. You should have the FSND-Virtual-Machine directory with the vagrant directory inside after the previous step;
6. Download and extract this repository so that you have it inside the vagrant directory;
7. In your terminal, cd to the vagrant directory and run the command vagrant up (this causes Vagrant to download the Linux operating system and install it. It may take quite a while depending on how fast your Internet connection is);
8. Run vagrant ssh command to log into the virtual machine;
9. Run cd /vagrant command to access shared files;
10. cd to the app directory (see step 6);
11. Run sudo -u postgres psql command to log in to the PostgreSQL as admin;
12. Run CREATE DATABASE <database>; command to create new database (replace <database> with your value);
13. Run CREATE USER <username> WITH PASSWORD '<password>'; command to create new database user (replace <username> and <password> with your values);
14. Run GRANT ALL PRIVILEGES ON DATABASE <database> TO <username>; command ( replace <database> and <username> with your values from steps 12-13);
15. Log out from the PostgreSQL (^D will do in most cases);
16. Modify config.py file to reflect your settings - change the values of DB_NAME, DB_USER, DB_PASSWORD according to the values from steps 12 and 13. Changing APP_KEY is optional;
17. Make sure you are on the same level with the db_setyp.py file;
18. Run python db_setup.py command to create database tables;
19. Run python db_populate.py command to populate the database;
20. Run python app.py command to start the server;
21. In your browser, open localhost:8000; you will need a Google account and the Internet connection to log in.