search

pxlsspace / pxls-web

Web client for pxls.space
MIT License
9 stars 14 forks source link

readme

![Pxls](https://i.imgur.com/udeloqX.png) ![Gulp CI](https://img.shields.io/github/actions/workflow/status/pxlsspace/pxls-web/gulp.yml?style=flat-square) [![GitHub issues](https://img.shields.io/github/issues/pxlsspace/pxls-web?style=flat-square)](https://github.com/pxlsspace/pxls-web/issues) [![GitHub pull requests](https://img.shields.io/github/issues-pr/pxlsspace/pxls-web?style=flat-square)](https://github.com/pxlsspace/pxls-web/pulls) [![GitHub contributors](https://img.shields.io/github/contributors/pxlsspace/pxls-web?style=flat-square)](https://github.com/pxlsspace/pxls-web/graphs/contributors) [![GitHub stars](https://img.shields.io/github/stars/pxlsspace/pxls-web?style=flat-square)](https://github.com/pxlsspace/pxls-web/stargazers)

Pxls is a collaborative canvas where users can place one pixel from a limited palette at a time, inspired by Reddit's r/Place experiment.

This repository holds the front end web client. The back end can be found here.

Installation

Automatically built files are available as artifacts on each push here.

Building

The following are required on both the build and target system(s):

Install dependencies with npm install.

To build, run npm run build in the project root.

Running

Copy the reference config.example.json5 to config.json5 and edit as necessary.

Run with npm start.

Licenses