1
Fork 0
mirror of https://github.com/Steffo99/todocolors.git synced 2024-12-23 07:14:23 +00:00
todocolors/README.md

1.8 KiB

Todocolors

A self-hostable multiplayer todo app with Redis, Rust, WebSockets and Next.js.

Warning:

This project is currently a prototype.

Features may be changed, break, or have security issues without anything being communicated!

The code is a bit better now, but still may get rewritten from scratch for the next iteration of the project!

Use and contribute at your own risk.

Screenshots

Screenshot of the application, detailing a nonsensical "Plan for conquering the world"

Architecture

The application is split in two modules:

Installation

To deploy your own instance of Todocolors, use the files contained in todopod/, tweaking the network_mode and ports of the caddy container as you see appropriate.

Data will be stored in the data/redis/rdata/ directory.

Further customization

For more customization, make changes and then build your own Docker images using the provided Dockerfile in todored/ and todoblue/.

Build

Build instructions are provided for the two modules:

Development

Development instructions are provided for the two modules:

License

This project is licensed under the EUPL-1.2.

Attribution

Open source attributions are split by module, see: