News Feed is a backend service designed to facilitate a social media-like experience, allowing users to engage in various activities such as creating posts, following other users, adding comments to posts, and more. Built with Golang, Gin, GORM, and PostgreSQL, News Feed provides a robust platform for managing user interactions.
High Level System Design
I aim to develop a News Feed engine operating on a Pull Model rather than a Push Model. Additionally, I intend to implement a feature that ensures users are presented with predominantly positive posts, while downgrading negative posts within the system itself.
- User Authentication: Users can securely sign up and log in to access the News Feed platform.
- Create Posts: Users have the ability to create posts to share with their followers and the wider community.
- Follow Other Users: Users can follow other users to stay updated with their posts and activities.
- Add Comments: Users can engage with posts by adding comments, fostering discussion and interaction within the community.
- JWT Verification: Secure JSON Web Token (JWT) verification ensures the integrity and authenticity of user interactions.
- Persistent Storage: News Feed utilizes PostgreSQL along with GORM for efficient and reliable data storage.
- Field Validation: Input fields are validated to maintain data integrity and prevent errors.
- Structured Logging: Logging is structured for easier monitoring, debugging, and analysis.
- Pagination: Pagination is implemented to efficiently handle large volumes of data and improve performance.
- Redis Cache: Redis Cache is used for smooth login process and improved response time.
- Rate Limiter: A User ID based rate limiter has been added to limit multiple posts by the same user.
- Sentiment Analysis: Implemented a Flask-based backend service leveraging Hugging Face's Transformer library for sentiment analysis, seamlessly integrating with a pre-trained CardiffNLP Twitter-RoBERTa model.
- Push Based Model: Our system utilizes a push-based model for populating the cache, ensuring that users have access to the latest posts in real-time.
- Golang: The core programming language used for building the backend logic.
- Gin: A lightweight HTTP web framework for building APIs in Go.
- Redis Cache: A in-memory data store used as a cache, vector databases.
- GORM: An ORM library for Go, used for interacting with the PostgreSQL database.
- PostgreSQL: A powerful, open-source relational database management system.
- Docker Compose: Docker Compose is used for defining and running multi-container Docker applications.
To get started with News Feed, follow these steps:
- Clone the repository to your local machine.
- Navigate to the project directory.
- Configure the environment variables, database settings, and any other necessary configurations.
- Build and run the Docker containers using
docker-compose upfor postgres image - Go to the root repositry and run
go run main.gocommand this will start the API server - Access the API endpoints using the provided routes.
- POST api/signup: Sign up a new user.
- POST api/login: Log in an existing user.
- POST api/posts/create: Create a new post.
- GET api/posts: Get a list of posts.
- GET /posts/:id: Get details of a specific post.
- POST /posts/comment: Add a comment to a post.
- POST /users/:id/follow: Follow a user.
- GET /users/:id/posts: Get posts from a specific user.
Contributions are welcome! If you'd like to contribute to News Feed, please follow the standard GitHub flow:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and ensure the code is properly tested.
- Submit a pull request detailing the changes made and any relevant information.
This project is licensed under the MIT License.