SyntaxSphere Project

Overview

SyntaxSphere is a Django-based project that provides user authentication, including GitHub OAuth, and post management functionalities. This document outlines the available API endpoints and the required data for each endpoint.

Endpoints

User Authentication

Sign Up

• URL: /signup/
• Method: POST
• Description: Register a new user.
• Request Data:

  {
  "username": "string",
  "email": "string",
  "password": "string",
  "first_name": "string",
  "last_name": "string"
  }

• Response:

  {
  "refresh": "string",
  "access": "string"
  }

Sign In

• URL: /signin/
• Method: POST
• Description: Authenticate an existing user.
• Request Data:

  {
  "username": "string",
  "password": "string"
  }

• Response:

  {
  "refresh": "string",
  "access": "string"
  }

Sign Out

• URL: /signout/
• Method: POST
• Description: Log out the authenticated user.
• Request Data:

  {
  "refresh": "string"
  }

• Response: HTTP 205 Reset Content on success, HTTP 400 Bad Request on failure.

OAuth

GitHub OAuth

• URL: /accounts/github/login/

• Method: GET

• Description: Redirect to GitHub for authentication.

• Response: Redirects to GitHub login page.

• URL: /accounts/github/login/callback/

• Method: GET

• Description: GitHub callback URL.

• Response: Redirects to the application with the authentication result.

Post Management

List Posts

• URL: /posts/
• Method: GET
• Description: Retrieve a list of all posts.
• Response:

  [
  {
    "id": "uuid",
    "title": "string",
    "url": "string",
    "user_id": "string",
    "posted_at": "datetime",
    "like_count": "integer"
  },
  ...
  ]

Create Post

• URL: /posts/
• Method: POST
• Description: Create a new post.
• Request Data:

  {
  "title": "string",
  "url": "string"
  }

• Response:

  {
  "id": "uuid",
  "title": "string",
  "url": "string",
  "user_id": "string",
  "posted_at": "datetime",
  "like_count": "integer"
  }

Retrieve Post

• URL: /posts/<uuid:id>/
• Method: GET
• Description: Retrieve a specific post by its ID.
• Response:

  {
  "id": "uuid",
  "title": "string",
  "url": "string",
  "user_id": "string",
  "posted_at": "datetime",
  "like_count": "integer"
  }

Delete Post

• URL: /posts/<uuid:id>/
• Method: DELETE
• Description: Delete a specific post by its ID.
• Response: HTTP 204 No Content on success.

Like Management

Like Post

• URL: /posts/<uuid:pk>/like/
• Method: POST
• Description: Like a specific post.
• Response:

  {
  "id": "uuid",
  "user_id": "string",
  "post_id": "string"
  }

Comment Management

List Comments

• URL: /posts/<uuid:pk>/comments/
• Method: GET
• Description: Retrieve a list of comments for a specific post.
• Response:

  [
  {
    "id": "uuid",
    "user_id": "string",
    "post_id": "string",
    "comment": "string",
    "posted_at": "datetime"
  },
  ...
  ]

Create Comment

• URL: /posts/<uuid:pk>/comments/
• Method: POST
• Description: Create a new comment for a specific post.
• Request Data:

  {
  "comment": "string"
  }

• Response:

  {
  "id": "uuid",
  "user_id": "string",
  "post_id": "string",
  "comment": "string",
  "posted_at": "datetime"
  }

Installation

Backend

1. Clone the repository:

   git clone https://github.com/ahmeddelattarr/SyntaxSphere.git

2. Navigate to the project directory:

   cd SyntaxSphere

3. Install the required dependencies:

   pip install -r requirements.txt

4. Apply migrations:

   python manage.py migrate

5. Run the development server:

   python manage.py runserver

Frontend

1. Navigate to the frontend directory:

   cd client

2. Install the required dependencies:

   npm install

3. Start the development server:

   npm start

License

MIT License

© 2024 Ahmed elattar