charity-bit/instagram-clone

A website appplication built using python (Django) that mimics Instagram.

Instagram-Clone

A website appplication built using python (Django) that mimics Instagram to allow users to

1. Post Images
2. Like Images
3. Save Images to their profiles
4. Follow and Unfollow other users
5. View posts by users have those of users they have followed be displayed in their timelines
6. Comment on any post
7. Search for any user and view their profile
8. Explore to view posts by all users
9. Edit their personal profiles



Table of Content

• Prequisite
• Application Structure
• Installation Requirement
• Technology Used
• Demo
• Licence
• Authors Info

Prequisite

• In order to be able to run the application you'll need to generate your cloudinary api key. Head over to Cloudinary and create an account.



Application Structure

The application uses Django's MVT (Model-View-Template) architecture which is a software design pattern for developing a web application.

Model - The model is going to act as the interface of your data. It is responsible for maintaining data. It is the logical data structure behind the entire application and is represented by a database (generally relational databases such as MySql, Postgres). Django Models




View - a view is called that interact with model and template, it renders a template Django views

Template - A template consists of static parts of the desired HTML output as well as some special syntax describing how dynamic content will be inserted. Django templates

File Structure




Installation

• You will need to clone the application and create a virtual and install the dependencies from requirements.txt.



$ git clone https://github.com/charity-bit/Instagram-Clone
$ python3 -m venv virtual 
$ pip install -r requirements.txt
$ pip list 
$ source virtual/bin/activate #to activate the virtual enviroment


create a .env file in the root folder to save your configuration variables that are neccessary in order for the application to run.


inside your .env file




CD_NAME="cloud name app from cloudinary"
CD_API_KEY="api key from cloudinary"
CD_API_SECRET="api secret from cloudinary" 

SECRET_KEY='your secret key'
DEBUG=True
DB_NAME='your db name'
DB_USER='your db user'
DB_PASSWORD='password to the db user'
DB_HOST='127.0.0.1'
MODE='dev'
ALLOWED_HOSTS='127.0.0.1'
DISABLE_COLLECTSTATIC=1

• Assuming you already created the application database, You can now run the application.

Run the application using

$ make / $ make serve / python3 manage.py runserver

Run tests

Run test to the models

$ make test / python3 manage.py tests

Technology Used

• python Django
• PSQL
• Javascript
• CSS
• Ajax and Jquery



Demo

Timeline




Explore




Add Post




Add Comment




User Profiles




Licence

copyright © Charity 2022 - MIT

Authors Info

-LinkedIn - Charity Nyanchera

-twitter - CcNyanchera