Warbler

A Twitter clone with a cooler bird.

Getting Started

Follow the instructions below to get a copy of the project up and running on your machine for development and testing. See deployment for notes on how to deploy the project on a live system.

Prerequisites

• Python 3.6 or higher
• PostgreSQL
• The following databases
  • warbler (for dev)
  • warbler-test (for testing)

Installing

1. Clone the repo
2. Create a venv (virtual environment) for the app by doing the following:

$ python3 -m venv venv
$ source ./venv/bin/activate

3. Install the packages in requirements.txt with:

$ pip install -r requirements.txt

4. Create the warbler and warbler-test databases in PostgreSQL and load data:

• Dev database and data:

$ createdb warbler
$ psql warbler < data.sql

• Test database and data:

$ createdb warbler-test
$ psql warbler-test < data.sql

5. Start the server:

$ flask run

Running Tests

All tests: python -m unittest

Specific test: python -m unittest [testfile-name.js]

Built With

• Python - language for server
• Flask - web app framework
• Jinja2 - HTML templating language for Python
• bcrypt - password hashing
• Flask-SQLAlchemy - extension for Flask to support SQLA ORM
• psycopog2 - PostgreSQL adapter for Python
• Flask-WTF - form validation and rendering library for Python with Flask integration