Skip to content

Latest commit

 

History

History
70 lines (52 loc) · 2.26 KB

README.md

File metadata and controls

70 lines (52 loc) · 2.26 KB
Raw

Warbler

Warbler is a Twitter clone for bird lovers, so tweet your thoughts and warble it up!

It is a full-stack web application built with Flask, Python, Jinja, WTForms, PostgresSQL and SQLAlchemy. Warbler is engineered with encryption and password hashing, user authentication and authorization, RESTful routing, as well as thoughtful database designs and models.

Live Demo Link

Warbler Demo

Features

  • Users can sign up for an account, log in and edit their profile (including updating profile picture)
  • Users can create posts, referred to as "warbles"
  • Users can like and unlike warbles
  • Users can view a list of warbles they have liked
  • Users can follow other users and see who is following them
  • Users can view a news feed, containing warbles of users that they follow
  • Users can view a list of their own posted warble
  • Users can delete their own warbles
  • Users can search for a specific user or post, using keywords

Getting Started

To get started with Warbler, follow the steps below:

  1. Clone the repository to your local machine.
  2. Navigate to warbler directory: cd flask-warbler
  3. Create Python virtual environment: python -m venv venv
  4. Activate virtual environment: source venv/bin/activate
  5. Install dependencies with pip install -r requirements.txt
  6. Create database: createdb warbler
  7. Add environment variables: create a .env file, following instructions in .env.example to get variables correctly set up
  8. Seed database: python seed.py
  9. Start server: flask run -p 5001
  10. Open http://localhost:5001/ to view project in the browser

Testing

Tests are run using unittest. To run the tests, follow the steps below:

  1. Open a terminal.
  2. Ensure you are in warbler directory: cd flask-warbler.
  3. Create and activate virtual environment (follow steps 3-5 from "Getting Started").
  4. Run FLASK_DEBUG=False python -m unittest to execute the tests.

Tech Stack

  • Jinja/WTForms for frontend
  • Flask/Python for backend
  • PostgreSQL for database
  • SQLAlchemy for database ORM

Dependencies

  • Flask
  • Python
  • PostgreSQL
  • SQLAlchemy
  • Jinja
  • WTForms
  • Bcrypt
  • Gunicorn
  • jQuery
  • Bootstrap

Authors

  • Gracee Gallivan
  • JiHye Yoon (pair programming partner)