Pixels

An application API that allows its users to set pixels on a canvas. Like Reddit Place but more flexible and customizable. Visit the Yazılımcıların Mola Yeri server for more information and support. Have fun!

Content

• Features
• General
  • Prerequisites
  • Installation
  • Configuration
  • Building
  • Endpoints
    • Example objects
    • Example query parameters
  • Websocket Broadcast
• Others
  • Docs and Changelog
  • License

Features

Soon...

Prerequisites

• Dotnet 6.0 SDK
  • You can install Dotnet 6.0 SDK via installer on Windows and macOS.
  • If you want to install Dotnet 6.0 SDK to GNU/Linux, check out this page.

Installation

You can clone the repository using:

$ git clone https://github.com/yazilimcilarinmolayeri/pixels.git

Or you can simply download the files here...

Configuration

After you clone this repository or simply downloaded the files, you must fill in the required configuration fields in appsettings.Development.json. Then run the SQL script named Structure.sql on your PostgreSQL server.

You can change listening ports Properties/launchSettings.json Here is the default ports for each environment:

Environment	HTTP	HTTPS
Development	7000	7001
Production	5000	5001

Building

You can build the project using launch profiles.

If you want to build the project using development environment, execute:

$ dotnet run --launch-profile "Development"

If you want to build the project using production environment, execute:

$ dotnet run --launch-profile "Production"

Endpoints

There are few endpoints which users can use.

Endpoint	Description
/api/canvas/{canvasId?}	Users can execute a GET request here to fetch currently active canvas' image. If canvasId is specified, will return the specified canvas.
/api/canvas/{canvasId}/heatmap	Users can execute a GET request here with Heatmap query parameters to get heatmap image of given canvas.
/api/canvas/{canvasId}/snapshot/{timestamp}	Users can execute a GET request here to get the snapshot image of given canvas at given timestamp.
/api/canvas/{canvasId}	Moderators can execute a PUT request here with a PutCanvasModel object to create a new canvas.
/api/canvas/{canvasId}	Moderators can execute a PATCH request here with a PatchCanvasModel object to update a canvas.
/api/user/{discordId}/ban	Moderators can execute a PATCH request here to ban a user. A moderator cannot ban himself/herself.
/api/pixel	Users can execute a PUT request here with a SetPixelModel object to put a pixel to currently active canvas.
/api/pixel/{x}-{y}	Users can execute a GET request here to fetch the pixel information on currently active canvas.
/api/auth/login	Users must login and get a jwt token from this endpoint in order to use the API. This endpoint simply redirects the user to Discord OAuth authentication page.
/api/auth/discord/callback	Users will come to this endpoint after they authenticate with their Discord account. This endpoint will authenticate them using a jwt token.

Example objects

• Example of a SetPixelModel object: {"x": 10, "y": 15, "color": "f30a2b"}
• Example of a PutCanvasModel object: {"size":{"x": 350, "y": 350}, "dateExpire": 161487240}
• Example of a PatchCanvasModel object: {"size":{"x": 350, "y": 350}, "dateExpire": 161487240}
  • The keys Size or DateExpire can be null if moderators do not want to update them.

Example query parameters

• Example of Heatmap parameters for /api/canvas/{canvasId}/heatmap route: fromTimestamp=1650626540&toTimestamp=1650626569&actionColor=65280
  • If toTimestamp is not provided, the heatmap snapshot will draw actions from fromTimestamp until now.
  • If actionColor is not provided, the heatmap snapshot will draw action pixels with red color (#ff0000)

Websocket Broadcast

Users can listen to the websocket (default url is wss://localhost:<PORT>) for pixel updates. Users must send their jwt tokens when connecting to websocket. Any updates will be sent from the server to all listeners.

Docs and Changelog

Pixels documentation lives at X (not yet) and changelog lives at changelog.

License

This project is licensed under the MIT - see the LICENSE file for details.