Code Monkey home page Code Monkey logo

soengram's Introduction

Soengram

A photo sharing social networking website

About this Project

Social media platforms provide instant gratification and analytical data among users - businesses, celebrities, influencers and everyday individuals - as they are able to gauge engagement and impact through their posts and comments received by other users. Follower count is a measure by which users can gauge their popularity among other users on the platform. Soengram provides users all these tools by allowing users to easily interact with others through posting photos on their account timeline and spark conversation through commenting on posts. Users are also able to stay up to date and informed by following friends, family and favorite celebrities and influencers.

Objective

Develop a photo sharing social networking website where businesses, celebrities, influencers and regular everyday individuals can post photos, comment on posts and follow other users.

Features

  • Post pictures with description
  • Follow other users on the platform
  • Comment on other users posts

Built With

Getting Started

Prerequisites

Before you continue, ensure you have installed the following requirements:

Setup

  1. Clone the repository
    $ git clone https://github.com/LujainKhalaf/Soengram.git
  2. Create a virtualenv and activate it
    $ cd Soengram
    
    # Windows
    $ py -3 -m venv venv
    $ venv\Scripts\activate
  3. Install all packages
    $ pip install -r requirements.txt
  4. Setup a local PostgreSQL database
  5. Copy .env.sample, rename to .env and edit the following lines
    DB_TYPE="postgresql"
    DB_HOST="localhost"
    DB_PORT="5432"
    DB_USERNAME="your_username"
    DB_PASSWORD="your_password"
    DB_DATABASE="soengram"
    
    # Windows
    POST_UPLOAD_FOLDER = '\\static\\post_images\\'
    
  6. Prep the db by running this command in the root of the project
    $ python3 ./seed/db_prep.py
  7. Make the db migrations
    $ flask db upgrade
  8. Seed test data
    $ python3 ./seed/seed.py
  9. Start application
    $ flask run

Running the Tests

Run all tests with the following command in the project virtual environment.

$ pytest

Contributing

See CONTRIBUTING.md detailing basic guidlines for pushing new code to the repo and a basic workflow example.

Acknowledgments

Soengram is an educational non-profitable project based on the social networking service Instagram. The design and functionalities are adapted from Instagram to meet project requirements. This web application is not hosted for commercial use, but rather for academic purposes.

Copyright © 2021 Soengram adapted from Instagram and customized by Soengram team

Libraries

This project uses the following libraries:

Team

soengram's People

Contributors

davrine avatar domsec avatar fadi-albasha avatar jason-gerard avatar lealakkis avatar lujainkhalaf avatar mnashat avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.