nyeong / realworld-elixir Goto Github PK

Entity

• User
• Article
• Comment
• Tag

Attributes

• User: email, password, username, bio, image, written_articles, followed_by, following, comments, favorites
  • email should be unique (users authenticate with an email)
  • username should be unique (profiles API queries a user by given username)
• Article: title, description, body, tag, author, slug, comments, favorites_count, created_at, updated_at
• Comment: created_at, updated_at, body, author
• Tag: name

Relationships

• User <-> User (follow)
• User |-> Article (write)
• User |-> Comment (write)
• User <-> Article (add to favorite)
• Article |-> Comment (be commented on)
• Article <-> Tag (tagged)

• <-> means N:N relationship.
• |-> means 1:N relationship.

Oh no

I don't know the differences between the User entity and the Profile entity¹.

I think it's OK to store those on the same table because they deal with the same topic, the User. To present those on different APIs might be enough.

Goals

Implements next endpoints:

• registration: POST /api/users
• get current user: GET /api/user
• update user: PUT /api/user

Refers

• https://www.realworld.how/docs/specs/backend-specs/endpoints

Implements authenticate users via JWT

https://www.realworld.how/docs/implementation-creation/features

Following features must be implemented.

• #3 (login/signup pages + logout button on settings page)
• #4 (sign up & settings page - no deleting required)
• #5
• CR-D Comments on articles (no updating required)
• GET and display paginated lists of articles
• Favorite articles
• Follow other users