@feltjs/felt NPM

`@feltjs/felt`

a programmable platform for hobbyists and human-scale communities 💚 @feltjs
work in progress: pre-alpha

Felt is a Node.js server that you can use in many different ways:

as an end user using Felt like Slack or Discord, but with more power to build custom experiences
as an operator user deploying an instance to the web via servers IRL, doing admin and infra
(coming soon) as a dev user making a custom server using the library on npm
as a dev user downloading or forking this repo with git, adding or changing anything you wish

getting started

To learn about the project, see felt.dev/about. We'll link to a video introduction with the alpha announcement.

To play with the code, see Getting started and Contributing. Docs are a work-in-progress at felt.dev/docs, including our known issues.

To deploy to production, see Deploying production and Managing production.

The server has integrated reference docs, which we'll link after the alpha announcement. We also publish our vocabulary as a JSON Schema.

using `@feltjs/felt` as a library

support for this coming soon - it's published to npm but not yet usable

@feltjs/felt can be installed as a library on npm to make custom servers:

npm i -D @feltjs/felt # see the available modules at `/src/gro.config.ts`

Learn more about using @feltjs/felt as a library.

local development

To work directly on the codebase, see Getting started, then:

# node >=20.10
npm i

# start SvelteKit/Vite and the Node server
npx gro dev # args are forwarded to `vite dev`
gro dev # install Gro globally: npm i -g @grogarden/gro

# browse to localhost:5173 or whatever it says

gro # print available tasks
gro test