Skip to content

Latest commit

 

History

History
227 lines (184 loc) · 6.72 KB

README.md

File metadata and controls

227 lines (184 loc) · 6.72 KB
Raw

CS50 - Network project

Table of contents

Introduction

Description and requirements

Using Python, JavaScript, HTML, and CSS, complete the implementation of a social network that allows users to make posts, follow other users, and like posts.

All requirements can be viewed here: https://cs50.harvard.edu/web/2020/projects/4/network/

Live version can be viewed here: https://cs-50-network.herokuapp.com/ (it might take a second to load 😉)

You must be registered to use options such as commenting, profile picture, following and so on.

Versions

On this repository you can find 2 versions of this project:

  1. master branch: allows file uploads for user profile
  2. live-server-version branch: uses img url istead of file upload to avoid using s3 buckets for demonstration

Installation

To set up this project on your computer:

  1. Clone the project
  2. Install all necessary dependencies 
        pip install -r requirements.txt
  3. Make a migration 
        python manage.py migrate

Preview

Edit your profile

edit-profile

Add posts

add-posts

Add comments

add-comments

Add likes

add-likes

Edit a comment or a post

edit

Delete a comment or a post

delete

Follow

follow-user

View profile

view-profile

Change language

change-language

Implementation

Models

User Profile

Contains User Model extension with additional fields.

Fields:

  • name - user's name
  • date_of_birth - user's birth date
  • about - additional info about the user
  • country - user's birth place
  • image - user's profile photo

Post

Contains all post info.

Fields:

  • user - who posted the post
  • content - post's inner text
  • date - post's publication date

Comment

Contains all comment info.

Fields:

  • user - who posted the comment
  • post - the post which is being commented
  • content - comment's inner text
  • date - comment's publication date

Like

Contains all like info.

Fields:

  • user - who liked a post/comment
  • post - the post which has been liked
  • comment - the comment which has been liked
  • emoji_type - the emoji used as a like, available emojis:
    1. like
    2. dislike
    3. smile
    4. heart
    5. thanks

Following

Contains all who follows who info.

Fields:

  • user - user who is following
  • user_followed - user who is being followed

Views

index

Here you can:

  • View all posts
  • Edit posts (if you are the post's creator; only for logged-in users)
  • Delete posts (if you are the post's creator; only for logged-in users)
  • Like them (only for logged-in users)
  • Create a new post (only for logged-in users)
  • View all comments (only for logged-in users)
  • Create a comment (only for logged-in users)
  • Delete a comment (if you are the comment's creator; only for logged-in users)
  • Edit a comment (if you are the comment's creator; only for logged-in users)

post_comment

(only for logged-in users)

Controls saving of a new post/comment (only POST method allowed).

user_profile

(only for logged-in users)

Here you can:

  • View user's bio
  • View all user's posts
  • Edit posts (if you are the post's creator)
  • Delete posts (if you are the post's creator)
  • Like them
  • View all comments on user's posts
  • Create a comment
  • Delete a comment (if you are the comment's creator)
  • Edit a comment (if you are the comment's creator)
  • Follow the user (if you are not this user)
  • Click on edit profile button (if you are this user)

edit_profile

(only for logged-in users)

Here you can:

  • Change your name
  • Change your birthdate
  • Change your about info
  • Change your profile picture
  • Change your country

like

(only for logged-in users)

Controls all actions regarding liking:

  • Add a new like
  • Change a like's emoji

following

(only for logged-in users)

Here you can:

  • View all posts created by followed users
  • Like them
  • View all comments
  • Create a comment
  • Delete a comment (if you are the comment's creator)
  • Edit a comment (if you are the comment's creator)

follow_unfollow

(only for logged-in users)

Controls following/unfollowing users (only POST method allowed).

login_view

Controls logging in.

logout_view

Controls logging out.

register

Controls registration.

Tests

There are 4 main test cases:

  • ModelsTestCase - checks database integrity
  • FormsTestCase - makes sure that forms work correctly
  • ViewsTestCase - makes sure that all views work correctly and give proper responses
  • FrontEndTestCase - uses Selenium to simulate user interaction with every element on the page

Test requirements can be viewed in test requirents.md

Special thanks to Brian and the entire CS50 team for making learning easy, engaging, and free.