pixelland-chat

README

PixelLand Chat

Discord-style embedded chat used in PixelLand.

PixelLand is an online community where people create and share pixel-art. The chat is an integral part that allows people to collaborate or just hang out.

Pixel.Land — PixelLand Discord — Docs (coming soon)

How to run things locally

Getting Started

Install Node (version 18+)

Install Go (version 1.19+)

Install pgAdmin

Open pgAdmin and create a new database. The owner and database name can be whatever you want.

Set Environment Variables

Set the following environment variables with your database connection parameters. NOTE If you're already using the default value then you don't need to set the environment variable.

export CHAT_SQL_DB_NAME=<your db name, default=pixellandchat>
export CHAT_SQL_PORT=<your db port, default=5432>
export CHAT_SQL_USER=<your db user, default=postgres>
export CHAT_SQL_PASSWORD=<your db password, default=123>

If you're setting up the database for the first time, then set seed_db = true

export CHAT_SEED_DB=true

Run the Backend 🤞

Clone this repo: git clone https://github.com/wwwillw/pixelland-chat.git

cd pixelland-chat
go run .

Run the UI 🤞

Once the backend is running, open a new shell and run:

cd pixelland-chat/ui
npm install
npm run dev

🏃It should now be running at http://localhost:3001/

NOTE I've probably forgotten a step! If something's not working then create a Github issue or send me a message on the PixelLand Discord (@will).

License

PixelLand Chat is free software licensed under GNU GPLv3.