Pybook - Social Network

Features • Preview • Instructions • Testing • Technologies • To Do

An open-source Social Network project called Pybook written in Django.

✨ Features

Clone this repository, cd into it

git clone https://github.com/hatredholder/Social-Network.git
cd Social-Network

Start a new Virtualenv, activate it, install Python module requirements on it

virtualenv myenv
source myenv/bin/activate
pip install -r requirements/base.txt

Create a PostgreSQL database

CREATE DATABASE socialnetworkdb;

Create a .env file with enviroment variables of APP_SECRET, DB_NAME, DB_USER, DB_PASSWORD, DB_HOST, DB_PORT

APP_SECRET=your_very_very_secure_secret_key
DB_NAME=socialnetworkdb
DB_USER=user
DB_PASSWORD=password
DB_HOST=localhost
DB_PORT=5432

Apply migrations to the database and run the Django server

python manage.py migrate 
python manage.py runserver

To use the tests you need to install local module requirements first, to do that, use:

pip install -r requirements/local.txt

To run the tests and check the coverage use:

pytest --cov

To generate an HTML coverage report use:

pytest --cov-report html:cov_html --cov

And finally to test the code quality (see if there are any PEP8 errors) use:

flake8

Frontend: CSS, Semantic UI

Backend: Django, a tiny bit of JavaScript

Database: PostgreSQL

Tests: Pytest, Pytest-Django

Click to Open