commune-forum app architecture validation

[vinicius-sacramento]

Project Overview

Inspiration

This project draws inspiration from the Hacker News website, offering features like the ability to "submit external posts or content." Users can share articles, posts, or updates they've published on social media or personal blogs with the community.

However, we're aiming to take it a step further. In addition to the classic Hacker News-style interface, we plan to introduce new and more user-friendly features. Users will be able to create original posts directly on our platform, similar to creating a proposal.

Think of it as a fusion of the Hacker News format with enhanced governance features, offering a more dynamic and interactive experience.

---

User Stories

1. Authentication (Implemented via AuthRoutes in ./packages/api)

   • Users can authenticate using their Polkadot wallets.
   • Sessions expire after 6 hours for security.

2. Posts (Similar to proposals)

   • Users can create, edit, and delete their own posts.
   • Users can assign multiple categories to their posts.
   • Admin users can pin posts to highlight them.

3. Categories

   • Admin members can manage categories (create, edit, delete).
   • Users can view and filter posts by categories.

4. Voting (Similar to proposal comments)

   • Users can upvote or downvote posts.
   • Users can change their votes.
   • The system prevents multiple votes from the same user on a single post.

5. Comments (Similar to proposal comments)

   • Users can add, edit, and delete their own comments.

6. Viewing and Tracking

   • Users can view all posts and comments.
   • The system tracks and displays the number of views per post.

---

Entities

1. User

• Fields:

  • walletAddress (String, Primary Key): The user's Polkadot wallet address.
  • role (Enum): User role, either 'Regular' or 'Admin'.

• Notes:

  • Users are identified solely by their wallet addresses.
  • Roles are managed through the existing Cadre Page on the governance app.

---

2. Session (Handled by AuthRoutes)

• Notes:
  • Sessions last for 6 hours.
  • A valid session is required to interact with the application (except for viewing posts and comments).

---

3. Category

• Fields:

  • id (UUID, Primary Key): Unique identifier for the category.
  • name (String): Name of the category.
  • description (String, optional): Description of the category.

• Notes:

  • Categories classify posts and are managed by Cadre members.
  • A post can belong to multiple categories.

---

4. Post

• Fields:

  • id (UUID, Primary Key): Unique identifier for the post.
  • authorWalletAddress (String, Foreign Key to User): The author's wallet address.
  • title (String): Title of the post.
  • content (String): Markdown content or URL to an external link.
  • pinned (Boolean): Indicates if the post is pinned.
  • createdAt (DateTime): Timestamp when the post was created.
  • updatedAt (DateTime): Timestamp when the post was last updated.
  • deletedAt (DateTime, nullable): Timestamp when the post was deleted.

• Associations:

  • Categories: Many-to-many relationship with categories.
  • Votes: Users who have upvoted or downvoted the post.
  • Views: Number of users who have viewed the post.

---

5. Comment

• Fields:
  • id (UUID, Primary Key): Unique identifier for the comment.
  • postId (UUID, Foreign Key to Post): The ID of the associated post.
  • authorWalletAddress (String, Foreign Key to User): The comment author's wallet address.
  • content (String): Content in plaintext, Markdown, or possibly an external URL.
  • createdAt (DateTime): Timestamp when the comment was created.
  • updatedAt (DateTime): Timestamp when the comment was last updated.
  • deletedAt (DateTime, nullable): Timestamp when the comment was deleted.

---

To Be Defined

• Voting Eligibility:
  • Users must have a minimum number of stakes/coins to vote. (Value requires further discussion.)
  • ~Consider applying the same rule to commenting.~

---

Roadmap

As users become more engaged with the platform, we plan to introduce additional features:

• Leaderboard: Showcasing top creators.
• Trending Posts: Highlighting the most viewed posts over the last 30 days.
• Top Voted Posts: Featuring posts with the most likes or upvotes in the past month.

And many more exciting features to enhance user experience.

[vinicius-sacramento]

@steinerkelvin @EdSDR @PsicoThePato

[vinicius-sacramento]

As discussed earlier today on Discord, here are the changes.

Update

• Users must have a minimum number of stakes/comais to vote. (This value needs further discussion.) ~Perhaps the same rule should apply to comments?~

• Cadre members will no longer be allowed to control the network, and their ability to delete posts or comments will be removed.

• We need the ability to create new roles, such as "Admin" or similar.

• The "pin order" feature will be removed.

[vinicius-sacramento]

Update

• We need to include the title field in the list of Post fields.

• Below is a rough wireframe/sketch outlining the main flows of the application. This will be refined in Figma and further adjusted during development.

[vinicius-sacramento]

Quick Update:

We need to also provide a checkbox to allow the user to post it anonymously.