Skip to content

A community-driven, social media aggregation, content rating, and discussion website. Registered members submit content to the site such as text posts, images, and gifs which are then voted up or down by other members and may be shared via Twilio SMS/MMS API services. Posts are organized by subject via user-created communities called "subkeddits".

kumsy/keddit

Repository files navigation

About | Features | Docs | Stack | API

Developer:

Kristen Campbell


Detailed README.md currently in-progress
Please reference my demo video currently at: 

What's Keddit?

Keddit is a full-stack community-driven social media site built from the ground-up, inspired by  

Users are able to create an account, upload their custom profile picture, create communities, post topics, comment, share posts, and vote on posts and comments. Posts may be up-voted or down-voted by other registered members on Keddit. If a post from any community has enough up-votes, it may be featured on Keddit's front page often referred to as 'k/ popular'.


Features

Account Security
  • Password hashing via Bcrypt
  • Adds a layer of security.

Account Customization
  • Upload custom profile pictures
  • Edit username and email addresses

Create Communities
  • Also known as 'subkeddits'
  • Holds collection of posts relating to it's subject title.

Create Posts and Comments
  • Upload local files through Python's Imaging Libray
  • Giphy's API provides registered users with the option to use GIFs with their messages.
Upvotes and Downvotes
  • Registered users may vote on posts and comments
  • Javascript communicates with Python's backend to allow for asynchronous voting.

Cloud Hosting
  • Autonomous multimedia hosting and servicing provided through Cloudinary's API.
Post Sharing via SMS/MMS
  • A share button feature using Twilio's API allows for users to share posts via SMS/MMS.

and more coming soon!


Getting started

Requirements

In order to get started, you will need to setup personal API Keys. Please setup developer accounts at:
Download and install PostgreSQL

Installation

Clone Keddit's repository in a project directory:
git clone https://github.com/Kumsy/Keddit.git
Set up a virtual environment:
  • Mac
virtualenv env
source env/bin/activate
  • Windows
virtualenv env --always-copy
source env/bin/activate
Install dependencies:
pip3 install -r requirements.txt

💡  Note - Depending on system setup, you may need to install bcrypt separately:

pip3 install flask-bcrypt

Configuration

🔑  We will now use your API keys to configure our server.

Coming soon

Tech Stack

Backend:

from flask import Flask
from flask_sqlalchemy import SQLAlchemy 

db = PostgreSQL
print("Python")

Frontend:

console.log("JavaScript, JQuery, Ajax")
{% block content %}
  Bootstrap, CSS, HTML, and {% Jinja2 %} 
{% endblock %} 

             


APIs

Cloudinary - Images and GIFs from posts are automatically uploaded to a cloud server.

     Giphy - Users can search for their favorites GIFs powered by GIPHY.

    Twilio - Users can share posts and send the contents via SMS and MMS.


Author

Kristen Campbell is a Software Engineer in San Francisco, CA.

Keep in touch with Kristen! She's so friendly!

LinkedIn  Reddit  Twitter  Twitch 

Special Thanks:

  

About

A community-driven, social media aggregation, content rating, and discussion website. Registered members submit content to the site such as text posts, images, and gifs which are then voted up or down by other members and may be shared via Twilio SMS/MMS API services. Posts are organized by subject via user-created communities called "subkeddits".

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published