![Programming by Reading] (src/static/image/logo2.png)
This is the fourth full coding project which was completed under the Full Stack Web Designer for the Udacity nanodegree. It's purpose was to create an item catalog based the field which the user has chosen. The orignal lesson given was a Restaurant Menu Database. Through the lessons the design was expounded and given a new form.
Programming by Reading is meant to be a database of programming books that could be helpful to people who want to learn coding. Possible additions could be setting up so the users can review the books, also have a section on why the book is useful.
This program utilizes a two-level security system to prevent users from accessing material that they did not create.
- Client Level - This is the code specifically written in the jinja code that will do security checks to make sure that parts of the website are only accessible to the owners of the books.
- Code Level - In addition to the security that was written in the jinja code, there is also code that requires a user to be logged in to have access to certain methods. If, by chance, a user bypasses the first level they would get error messages letting them know that they could not modify it.
- [Python 2.7] (https://www.python.org/downloads/release/python-2712/) - Code the software was designed in.
- Git Account - This would be need to download the repository either through using 'git clone' or by downloading this as a zip.
- Google Account - To test out the Google+ third-party sign in.
Get the repository from github:
$ git clone https://github.com/jpdesigns316/item-catalog item-catalog
or Go to the repository on GitHub and click on the 'Clone or download' button. Unzip into a directory called item-catalog.
Setup Google Plus Authentication Application
- Go to https://console.developers.google.com/project and login with Google.
- Create a new project
- Name the project
- Select "API's and Auth-> Credentials-> Create a new OAuth client ID" from the project menu
- Select Web Application
- On the consent screen, type in a product name and save.
- In Authorized javascript origins add: http://localhost:5000, In Authroized redirect URI add: http://localhost:5000/login http://localhost:5000/gconnect
- Click create client ID
- Click download JSON and save it into the root director of this project.
- Rename the JSON file "client_secret.json"
- In the installation menu you can setup with your client id.
A installation menu has been created to help get this program configured
C:\%PATH_TO_CODE%\src\python runme.py
| Route | Function | Description |
|---|---|---|
| / | home() | Brings up the landing page of the website. |
| /login | show_login() | Render login.jinja2 page that lets the user login. |
| /gconnect | gconnect() | Allows the user to login to the website by using Google Plus. |
| /gdisconnect | gdisconnect() | Allows the user to disconnect from Google Plus. |
| File | Desciption |
|---|---|
| src/app.py | Project code containing code for the connection to thrid party sites |
| src/database_setup.py | Contains the model used in the database, and serializes them into JSON via init. |
| src/add_books_to_db.py | Set of default books used to add to the database for testing |
| src/client_secrets.json | This is used for the connection of third party authentication |
| src/config.py | Contains configuration information in the from of constants used in the program. |
| src/requirements.txt | The requirements of different Python modules not included in the base installation |
| src/run.py | Runs the webserver based on the infromation in app.py and the constants from config.py |
| Helper functions used to help keeping things simple. | |
| src/views/books.py | Blueprint used in the routes used to create the endpoints. |
| src/templates | Directory of the template files in jinja2 format to let the user know that jinja2 template format is being used. |
| src/static | Directory holding the static files for js, css, images, and fonts |
app.py
| File | Desciption |
|---|---|
| create_user(login_session) | Creates a user base on the infromation in the login_session. |
| get_user_id(email) | Look up the user id via the email that was accessed throught the thrid-party authentication. |
| get_user_info(user_id) | Get the user informaton from the User model after finding out the user_id |
| Route | Function | Description |
|---|---|---|
| books | home() | Brings up the landing page of the books. |
| add/book | add_book() | Utilizes the methond GET and POST to add a book to the database based upon the data in the Books model |
| delete/int:book_id | delete_book() | Removes a books for the database |
| books/int:language_id | get_language_page() | Will only list the books depending on the language_id |