Skip to content

Latest commit

 

History

History
215 lines (168 loc) · 5.2 KB

README.md

File metadata and controls

215 lines (168 loc) · 5.2 KB
Raw

SocialMediaApp

Social media forum application.

Boolean Academy Final Project - 2024

Project Board: https://github.com/users/ssuihko/projects/1

Documentation Google Doc: https://docs.google.com/document/d/1vTa7eyL9yXGx4kR44jwI93PREfyZFpwPiEOJM7W6_3M/edit?usp=sharing

This repository will contain both the frontend and the backend in their respective folders.

CORE

  • User should be able to create post,
  • User should be able to delete posts,
  • Home page all the posts,
  • User should be bale to click on a post and see details
  • User profile page
  • User should be able to update profile data
  • User can view the profile of any other user
  • User should be able to filter posts

EXTENSIONS

  • User should be able to comment on posts
  • User should be able to thumps-up/thumps-down a post/comment
  • User should be able to edit a post/comment
  • User should be able to see a list of his friends,
  • Authentication/login
  • CSS

TECHNOLOGIES

  • FE: React/Javascript
  • BE: C# .NET
  • DB: ElephantSQL

STRUCTURE

  • Homepage
    • PostList
    • Post
      • PostForm
      • CommentList
      • Comment
        • CommentForm
  • Profile
    • ProfileForm
  • Login
  • Sidebar
  • Header
    • Filter

API

USER

  • backend: friendslist: many-to-many relationship
frontend calls these backend endpoints:
  • GET all users: db.elephantsql.com/users → returns Array of User object, status 200 OK
  • GET a user: db.elephantsql.com/users/{user_id} → returns the User, or 404 not found
  • POST: db.elephantsql.com/users payload:
  {
    username: string,
    email: string,
    firstName: string,
    lastName: string
  }

returns: 400 bad request when a field is missing or a wrong field type is provided returns: 201 created when all the fields were provided correctly Created User Payload:

{
  id: integer,
  username: string,
  email: string,
  firstName: string,
  lastName: string
}
  • PUT: db.elephantsql.com/users/{user_id} payload (missing fields will be replaced with the old values)
  {
    username: string,
    email: string,
    firstName: string,
    lastName: string
  }

returns 404 not found when the user was not found by id returns 400 bad request when an updated field is not in acceptable format (validation error) returns 200 OK with the correct payload

  • DELETE: db.elephantsql.com/users/{user_id} returns 200 OK when id was found and deletion was succesful returns 404 when user with the id was not found

POST

  • backend: commentslist: one-to-many
frontend calls:
  • GET all users: db.elephantsql.com/posts → returns Array of Post objects, status 200 OK
  • GET a user: db.elephantsql.com/posts/{post_id} → returns the Post, or 404 not found
  • POST: db.elephantsql.com/posts payload:
  {
    userId: string,
    title: string,
    text: string,
  }

returns: 400 bad request when a field is missing or a wrong field type is provided returns: 201 created when all the fields were provided correctly Created Post Payload:

{
    id: integer,
    userId: string,
    title: string,
    text: string,
    likes: integer (0)
}
  • PUT: db.elephantsql.com/posts/{post_id} payload (missing fields will be replaced with the old values)
  {
    userId: string,
    title: string,
    text: string,
    likes: integer
  }

returns 404 not found when the post was not found by id returns 400 bad request when an updated field is not in acceptable format (validation error) returns 200 OK with the correct payload

  • DELETE: db.elephantsql.com/posts/{post_id} returns 200 OK when post with the id was found and deletion was succesful returns 404 when post with the id was not found

COMMENT

frontend calls:
  • GET all comments: db.elephantsql.com/posts/{post_id}/comments → returns Array of Comment objects, status 200 OK
  • GET a comment: db.elephantsql.com/posts/{post_id}/comments/{comment_id} → returns the Comment, or 404 not found
  • POST: db.elephantsql.com/posts/{post_id}/comments payload:
  {
    postId: integer,
    userId: integer,
    text: string,
  }

returns: 400 bad request when a field is missing or a wrong field type is provided returns: 201 created when all the fields were provided correctly Created Comment Payload:

{
    postId: integer,
    userId: integer,
    text: string,
    likes: integer
}
  • PUT: db.elephantsql.com/posts/{post_id}/comments/{comment_id} payload (missing fields will be replaced with the old values)
  {
    postId: integer,
    userId: integer,
    text: string,
  }

returns 404 not found when the comment was not found by id returns 400 bad request when an updated field is not in acceptable format (validation error) returns 200 OK with the correct payload

  • DELETE: db.elephantsql.com/posts/{post_id}/comments → deletes all comments of a post returns 200 OK when post with the post with the id was found and deletion was succesful returns 404 when post with the id was not found

  • DELETE: db.elephantsql.com/posts/{post_id}/comments/{comment_id} → deletes one comment of a post returns 200 OK when comment with the id was found and deletion was succesful returns 404 when post / comment with the id was not found