frome-assignment

Deployment/Running the backend

Clone the repository
Run docker compose build and docker compose up -dto start the backend server
The server will be running on http://localhost
Swagger documentation can be accessed at http://localhost/swagger

Requirements of the task

You are tasked with building a comprehensive RESTful API for a social media analytics platform. This API should provide various endpoints to analyze and retrieve data from any social media platform, with Twitter being the ideal focus. The API should allow users to retrieve insights, trends, and statistics about hashtags or any keywords.

Endpoints

Retrieve Posts Endpoint
- Description: Endpoint to retrieve posts based on a specific hashtag or keyword.
- Output Format: JSON (Keys and Values)
- Example Output:
```
{
   "id": {
       "data": "..."
   },
   "id": {
       "data": "..."
   }
}
```
Trends Analysis Endpoint
- Description: Endpoint to analyze trends and generate insights based on hashtag data.
- Example Output:
```
{
   "good": 2,
   "bad": 0,
   "better": 5
}
```
- Note: This is just an example; analysis can be extended to various metrics such as sentiment analysis.

List of all the hashtags

Description: Endpoint to retrieve a list of all hashtags.

Example Output:

{
   "results": [
    {
       "id": 1,
       "hashtag": "..."
    },
    {
       "id": 2,
       "hashtag": "..."
    }
   ]
}

Data Storage

Store social media data in a relational database - PostgreSQL.

Deployment

Deploy the API server to a cloud service provider like AWS using Docker.

Documentation

Document all API endpoints, requirements text, and instructions to run and deploy the API.
Create a GitHub repo, push everything to the repo, and update us.