Django Backend Setup and Running Instructions

This document provides the steps to set up and run the Django backend.

Table of Contents

• Prerequisites
• Steps to Set Up and Run the Backend
  1. Install the Required Packages
  2. Navigate to the Project Directory
  3. Run the Django Development Server
  4. Test the Routes Using Postman
• Routes
  • Posts Routes
  • Create Posts

Prerequisites

• Python installed on your machine
• If installed, make sure it's updated

  python -m pip install --upgrade pip

• Pip (Python package installer) installed

Steps to Set Up and Run the Backend

1. Install the Required Packages

Open a terminal and navigate to the project directory. Run the following command to install all required packages listed in requirements.txt:

pip install -r requirements.txt

2. Navigate to the Project Directory

Change directory to the app folder:

cd app

3. Run the Django Development Server

Start the Django development server by running the following command:

python manage.py runserver

4. Test the Routes Using Postman

• Open Postman.
• Use the appropriate HTTP methods (GET, POST, PUT, DELETE, etc.) to test the API endpoints.
• The server will be running at http://127.0.0.1:8000/ (or a different port if specified).

Ensure that you use the correct endpoints as defined in your Django project.

• Always ensure that your virtual environment is activated if you are using one.

Routes

Posts Routes

Create Posts

• URL:

  • POST /posts

• Function:

  • createPosts

• Description:

  • Creates a new post with specified title, content, author, date, initial likes, and dislikes and posts it to facebook.

• Parameters:

• Request Body Example:

  {
  "title": "Sample Post",
  "content": "This is the content of the post.",
  "author": "John Doe",
  "date": "2024-06-26"
  }

• Additional Instructions:

  Before using the /posts endpoint, ensure:

  • Add your bot email and password in the facebook_controller.py file for authentication.
  • Note: You need to be a member of the group to post if it is private.

• Returns:

  • Success: JSON response with a success message and HTTP status 201 (Created).
  • Error: JSON response with an error message and HTTP status 400 (Bad Request) if the request is invalid.