System requirements
Functional:
- User Auth/z
- Compose Tweets
- Follow/Unfollow Users
- Like Tweets
- Timeline
- Notifications
- Search
- Trending
- Profile Management
Non-Functional:
List non-functional requirements for the system...
Capacity estimation
Estimate the scale of the system you are going to design...
API design
- JWT Auth management system - cross platform, scales well
- User
- JWT auth, refresh
- TweetApi:
- Tweet
- TweetReply
- TweetShare - ???
- NewsfeedApi:
- Trending
- (share some infra with newsfeed)
- SearchApi
- UserAccountApi
Database design
erDiagram
USER {
string id "Primary Key"
string username
string email
string bio
string profile_picture
}
TWEET {
string id "Primary Key"
string content
datetime timestamp
int likes
int retweets
string user_id "Foreign Key referencing USER"
}
RELATIONSHIP {
string follower_id "Primary Key"
string following_id "Primary Key"
}
ACTION {
string id "Primary Key"
string type
string user_id "Foreign Key referencing USER"
string tweet_id "Foreign Key referencing TWEET"
}
HASHTAG {
string id "Primary Key"
string tag
}
MENTION {
string id "Primary Key"
string user_id "Foreign Key referencing USER"
string tweet_id "Foreign Key referencing TWEET"
}
MEDIA {
string id "Primary Key"
string url
string tweet_id "Foreign Key referencing TWEET"
}
High-level design
You should identify enough components that are needed to solve the actual problem from end to end. Also remember to draw a block diagram using the diagramming tool to augment your design. If you are unfamiliar with the tool, you can simply describe your design to the chat bot and ask it to generate a starter diagram for you to modify...
Request flows
Explain how the request flows from end to end in your high level design. Also you could draw a sequence diagram using the diagramming tool to enhance your explanation...
Detailed component design
Dig deeper into 2-3 components and explain in detail how they work. For example, how well does each component scale? Any relevant algorithm or data structure you like to use for a component? Also you could draw a diagram using the diagramming tool to enhance your design...
Trade offs/Tech choices
Explain any trade offs you have made and why you made certain tech choices...
Failure scenarios/bottlenecks
Try to discuss as many failure scenarios/bottlenecks as possible.
Future improvements
What are some future improvements you would make? How would you mitigate the failure scenario(s) you described above?