Welcome to Shredhub!

Table of Contents

• Overview
• Tools Utilized
• Contributors
• Project Configurations
• Acknowledgements

---

Overview

Shredhub is a Flask application in which users can write about their favorite places to shred, follow and message their fellow shredders, check out weather reports for their favorite resorts, and search blog posts to track down those hidden powder stashes... assuming folks decide to share them! 😎

Framework

Languages

Tools

Packages

Development Principles

Contributors

👤 Taylor Varoglu

• Github: Taylor Varoglu
• LinkedIn: Taylor Varoglu

Project Configurations

This project requires a local installation of Python3 and Flask

$ python3 -m virtualenv venv
$ source venv/bin/activate
(venv) $ pip install -r requirements.txt

Database Creation:

$ psql
 create database shredhub;
CREATE DATABASE
 \q

Database Initialization:

$ source venv/bin/activate
(venv) $ flask db migrate
(venv) $ flask db upgrade

How to Run the Test Suite:

$ source venv/bin/activate
(venv) $ pytest

How to Run the Local Server:

via Flask:

$ source venv/bin/activate
(venv) $ flask run
* Serving Flask app 'shredhub.py' (lazy loading)
* Environment: production
  WARNING: This is a development server. Do not use it in a production deployment.
  Use a production WSGI server instead.
* Debug mode: off
[2021-12-21 16:20:00,420] INFO in __init__: Shredhub startup
* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

via Docker:

$ docker-compose -f docker-compose-local.yml build && docker image prune
$ docker-compose -f docker-compose-local.yml up

Acknowledgements

• Background Image: Unsplash
• Email Server: Sendgrid
• Weather Data: OpenWeather One Call API