Project specification

index.rst

@@ -0,0 +1,121 @@
+.. _Instagram: https://www.instagram.com/
+
+DjangoGram
+==========
+
+The project is a social media site inspired by `Instagram`_, built using
+Django and Django REST framework. It focuses on fundamental Django
+functionalities, including user authentication, content management, and REST
+API integration. The site allows for image sharing, user interactions, and
+profile management.
+
+Project goals
+-------------
+
+-   Provide a practical learning experience in building a feature-rich social
+    media platform using Django.
+-   Focus on user privacy and data management, reflecting real-world
+    application requirements.
+-   Encourage best practices in REST API design and implementation.
+-   Develop an understanding of user role management and administrative
+    controls within a web application.
+
+Key features
+------------
+
+.. rubric:: User registration and authentication
+
+The application will provide user registration and authentication
+functionality, allowing individuals to create accounts, log in, and manage
+their profile information. This feature will enable authors to have
+personalized accounts and maintain ownership of their published images or
+stories.
+
+.. rubric:: Images gallery
+
+Users can upload their images to their own site page and maintain access
+restrictions. The entire gallery may be marked as private, or public. On
+the other hand each single image can be marked as private, or public.
+
+.. rubric:: Connections
+
+The site allows its users to create connections.
+Each user can send the connection request to another user.
+Once the request is approved by the target user, the connection is established.
+
+.. rubbic:: Site administration
+
+Site admins cannot delete anything from the site. However admins can mark any
+image uploaded to the site as "deleted", or block (deactivate) any registered
+account.
+
+Site administration functions
+-----------------------------
+
+-   Admin can remove any image uploaded to the site. The removal reason is
+    required. Removed image are not to be deleted; images of this kind just
+    become unavailable for other users.
+-   Admin can deactivate any registered user, except other admins. Deactivation
+    reason is required.
+-   Admin can ban (temporary deactivate) anu registered user, except other
+    admins. Deactivation reason and activation time should be provided.
+
+User registration and authentication
+------------------------------------
+
+-   For anonymous users there will be "Sign Up" and "Sign In" options available
+    on each page.
+-   For authenticated users "Logout" option is available from any site page.
+-   Deactivated users cannot log in and mainly acts as anonymous users.
+-   Deactivated users will receive a link to request the account restore from
+    site admins.
+-   Banned users (temporary deactivated) should see the ban timer on login
+    atempt.
+-   Authenticated users will be logout after being inactive for certain time.
+-   Admins should not be logout, regardless of activity.
+
+Connections
+-----------
+
+-   Authenticated users can review their connection with other users
+    on the "Connections" page.
+-   Authenticated users may send a connection request to each other.
+    Incomming requests are available on a connections page.
+-   Existing connections may be removed from the connections page, or
+    from the connected user personal page.
+-   When users have a connection, they can see personal pages of each other,
+    even in case some page is marked as "private".
+
+Personal page
+-------------
+
+The personal page is the gallery of images uploaded by a specific user.
+
+-   Authenticated users can upload new images to their gallery.
+-   Authenticated users can tag their images.
+-   Authenticated users can remove images from their gallery.
+-   Authenticated users can comment on images available for them.
+-   Authenticated users can change their personal page permissions
+    (e.g. make it public or private).
+-   Private galleries are not public available, any user must establish
+    the connection with the gallery owner to obtain access to private
+    gallery.
+
+Notifications
+-------------
+
+-   Notification should be available from any place of the site.
+-   When user uploads a new image, a notification is sent to all their
+    connections.
+
+Direct messages
+---------------
+
+-   Authenticated users can send direct messages to each other, unless they
+    aren't blocked by a message recepient.
+
+API
+---
+
+-   Project will implement REST API to provide **all** its functionality via
+    API endpoints.