https://github.com/burakkontas/discordclone

This project aims to create a backend system for a Discord-like application using microservices architecture. The architecture follows a star topology, where a central service acts as a mediator for communication between other services.
https://github.com/burakkontas/discordclone

asp-net-core aspnetcore-aspire entity-framework-core grpc grpc-client grpc-server microservices microservices-architecture mongodb postgresql rest-api restapi star-topology

Last synced: about 1 month ago
JSON representation

This project aims to create a backend system for a Discord-like application using microservices architecture. The architecture follows a star topology, where a central service acts as a mediator for communication between other services.

• Host: GitHub
• URL: https://github.com/burakkontas/discordclone
• Owner: BurakKontas
• License: mit
• Created: 2024-02-22T20:38:35.000Z (11 months ago)
• Default Branch: master
• Last Pushed: 2024-03-10T20:23:36.000Z (10 months ago)
• Last Synced: 2024-03-11T04:45:07.416Z (10 months ago)
• Topics: asp-net-core, aspnetcore-aspire, entity-framework-core, grpc, grpc-client, grpc-server, microservices, microservices-architecture, mongodb, postgresql, rest-api, restapi, star-topology
• Language: C#
• Homepage:
• Size: 220 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Discord Clone Backend

This project aims to create a backend system for a Discord-like application using microservices architecture. The architecture follows a star topology, where a central service acts as a mediator for communication between other services.

## Architecture Overview

### Components

- **CenterService**: The central service responsible for routing requests and orchestrating communication between other services.

- **MessageService**: A service handling message-related functionalities. Utilizes Elasticsearch as the database.

- **AuthService**: A service responsible for user authentication and authorization.

- **EmailService**: A service responsible for sending emails to various users.

### Communication

Communication between services is facilitated via gRPC, while the CenterService also exposes REST endpoints for external communication. The CenterService acts as a mediator, receiving requests via REST, then forwarding them to the appropriate services using gRPC. It also aggregates responses from different services and returns them to the client.

## Installation

### Prerequisites

- .NET Core SDK (Min. Version 8)

- Docker (optional, for running Elasticsearch)

- Visual Studio (Min. Version 17.9)

- .NET Aspire

### Steps

1. Clone this repository.

2. Navigate to `Discord.AppHost` and run `dotnet build` to build the projects.

3. Start `Discord.AppHost` service using `dotnet run` or by running the Docker containers (if configured).

## Usage

### REST Endpoints

#### CenterService

- **Messages**:

  - `POST /message/addmessage`: Add a new message.

  - `GET /message/getmessages`: Get all messages.

  - `GET /message/getmessage`: Get a specific message by ID.

  - `PUT /message/updatemessage`: Update a message.

  - `DELETE /message/deletemessage`: Delete a message.

  - `GET /message/getmessagesbychannel`: Get messages by channel.

  - `GET /message/getmessagesbyuser`: Get messages by user.

  - `GET /message/getmessagesbydate`: Get messages by date.

- **Authentication**:

  - `POST /auth/validatetoken`: Validates a token.

  - `POST /auth/banuser`: Bans a user.

  - `POST /auth/unbanuser`: Unbans a user.

  - `POST /auth/register`: Registers a new user.

  - `POST /auth/login`: Logs in a user.

  - `POST /auth/forgotpassword`: Initiates the process for resetting a password.

  - `POST /auth/refreshtoken`: Refreshes a token.

  - `POST /auth/extracttoken`: Extracts a token.

- **Email**:

  - `POST /email/sendaccountverificationemail`: Sends account verification email.

  - `POST /email/sendresetpasswordemail`: Sends password reset email.

  - `POST /email/sendcustomemail`: Sends custom email with body and subject to one or multiple mail address.

### gRPC Communication

Internal communication between services is done via gRPC. Each service defines its own protocol buffers (protobuf) messages and RPC methods for communication.

Check proto files in Protos folder of each microservices domain layer for gRPC service details.

## Contributing

Contributions are welcome! If you'd like to contribute to this project, please fork the repository, make your changes, and submit a pull request.

## License

This project is licensed under the [MIT License](LICENSE).