Skip to content

Requirements

zion edited this page Jan 19, 2025 · 1 revision

Requirements

Functional requirements

  • Register and login using a social media provider.
  • Users should be able to sign out.
  • Users should be able to create folders in their shelf.
  • Inside a folder, users can add an item by entering a title.
  • Optional item fields include author, link, notes, visibility, and read check.
  • Users should be able to edit fields of each item in their shelf.
  • Users should be able to delete items from their shelf.
  • Users should be able to add other users to their network and see each other's activity on a feed.
  • Users should be able to comment on other users' activity.
  • Users should be able to generate a PDF of a linked article.
  • Users should have a profile page where they have the option to see their friend list and their collections.
  • A public profile page will show the user's public collections and a list of recently added items.
  • Users should receive notifications for comments on their activity or updates in their network.
  • Users should be able to search for and filter items and folders within their shelf.

Non-functional requirements

  • Metadata fields are automatically retrieved when the user pastes an external link.
  • Items should have a thumbnail that is automatically generated.
  • Users should be able to sort items in a folder based on title, author, and date added.
  • Users should be able to rearrange folders and items in their shelf by dragging and dropping.
  • Mobile users should see a desktop equivalent shelf, feed, profile, and directory.

Overview

Getting Started

Project README

Design brief

Architecture

Database

Running Locally

Getting started

Environment variables

Useful commands

Clone this wiki locally