Twitter-Engine

Guided tour

1. 💡01

   Twitter Engine: A Mimic of Twitter Features

   Twitter Engine is a serverless application that replicates Twitter's core functionalities, allowing users to register, log in, tweet, and follow others. It provides real-time updates via WebSocket and a REST API for seamless interaction.

   • ✓Mimics Twitter features
2. 🛠02

   Event-Driven Architecture

   The application uses an event-driven architecture with WebSocket for real-time communication and a REST API for client-server interactions. Actors handle requests and responses, ensuring efficient processing.

   • ✓Uses WebSocket for real-time updates
3. 📄03

   Program.fs: Core Logic Implementation

   The Program.fs file contains the main logic for the server, including the REST API endpoints and WebSocket handling. This file showcases the developer's approach to structuring the application.

   Program.fs

   // Main server logic
   let startServer () =
       // Initialize server with Suave
       startWebServer defaultConfig app
   
   let app =
       choose [
           path "/register" >=> registerHandler
           path "/login" >=> loginHandler
           // WebSocket handling
           path "/websocket" >=> handShakeHandler
       ]

4. ✓04

   No CI Tests Configured

   Currently, there are no continuous integration tests configured for this project. Testing is likely manual or handled within the IDE.

   • !No CI workflows present
5. 🚀05

   No CI/CD Workflows Configured

   There are no CI/CD workflows configured for deployment in this project. Deployment instructions are not specified in the documentation.

   • !No deployment workflows present
6. ▶06

   Try It Out

   To run the application, clone the repository and open the UI.html file in a browser after starting the server in an IDE.

   git clone https://github.com/shashankcm95/Twitter-Engine

graph TD
    A[Client] -->|WebSocket| B[Server]
    B -->|REST API| C[Database]
    B -->|Actors| D[Request Handling]
    A -->|HTML UI| E[User Interaction]