AnthonyBronca / Pixtagram

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Pixtagram

Navigation

Overview

Pixtagram is a pixel perfect clone of dark themed Instagram where users can share posts with other users. They can show their support by liking and commenting other's posts.

Authors

  • Anthony Bronca
  • Maica Santos
  • Briana Robinson
  • Agustin Zucca

Sign Up

Sign up feature

User Profile

Profile

Comments and Likes

Comments and Likes

Search

Search

Technologies Used

Typing SVG

Getting started

  1. Clone this repository:

    git clone https://github.com/AnthonyBronca/Pixtagram.git
  2. Install dependencies with the following:

    pipenv install --dev -r dev-requirements.txt && pipenv install -r requirements.txt
  3. Create a .env file using the .env.example provided

  4. Setup your PostgreSQL user, password and database and make sure it matches your .env file

    Example psql commands:

    psql -c "CREATE USER <username> WITH PASSWORD '<password>'"
    psql -c "CREATE DATABASE <database name> WITH USER <username>"
  5. Get into your pipenv, migrate your database, seed your database, and run your flask app

    pipenv shell
    flask db upgrade
    flask seed all
    flask run
  6. Now you can use the Demo User or Create an account

Amazon Web Services S3

  • For setting up your AWS refer to this guide

Helpful commands

Command Purpose
pipenv shell Open your terminal in the virtual environment and be able to run flask commands without a prefix
pipenv run Run a command from the context of the virtual environment without actually entering into it. You can use this as a prefix for flask commands
flask db upgrade Check in with the database and run any needed migrations
flask db downgrade Check in with the database and revert any needed migrations
flask seed all Just a helpful syntax to run queries against the db to seed data. See the app/seeds folder for reference and more details

Features

Users

  • Guest users can create a new account
  • Logged in users can read/view other user accounts
  • Logged in users can update/edit their profile details and upload a profile photo
  • Logged in users can delete their profile

Posts

  • Users can create a post on Pixtagram
  • Users can read/view other posts
  • Users can update their posts
  • Users can delete their posts

Comment

  • Users can create comments on posts
  • users can read/view all of the comments on a post
  • Users can delete their comments on a posts
  • Help me

Likes

  • Users can like posts
  • Users can remove likes on posts

Search

  • Dynamic search bar. The search bar will change as the user types.
  • Search-bar will send users to profile. Search is based on usernames

Acknowledgments

  • Inspired by Instagram
  • Icons by Font Awesome

About


Languages

Language:Python 53.2%Language:CSS 43.2%Language:Dockerfile 2.5%Language:HTML 0.5%Language:Mako 0.5%Language:Shell 0.1%Language:Procfile 0.0%