Awesome Open Source
Awesome Open Source

Comet (joincomet.app)

Banner

All-in-one chat and forums for communities.

Tech Stack

Frontend

Backend

Join our Discord server

Development Instructions

Frontend

Development

Start dev server:

  • yarn run dev:web

Production

The frontend is a React app, and can be deployed in many ways. joincomet.app is using GitHub Pages in this repo, but another good option is Cloudflare Pages

Build frontend:

  • yarn run build:web

Environment variables:

  • VITE_API_DOMAIN (domain server is running on i.e. api.joincomet.app)

Backend

Development

Start dev server with below environment variables:

  • yarn run dev:server

Environment variables:

  • DATABASE_URL (defaults to postgresql://postgres:[email protected]:5432 if left blank)
  • ACCESS_TOKEN_SECRET (required, secret used for encrypting passwords)
  • REDIS_URL (optional, in-memory will be used if not provided)

The following environment variables are related to S3 file uploads and are required for file uploads to work. Comet has only been tested with DigitalOcean Spaces, but may also work with AWS S3.

  • MEDIA_DOMAIN (domain media is hosted on i.e. media.joincomet.app)
  • BUCKET (name of bucket, DO Spaces requires this to be same as MEDIA_DOMAIN i.e. media.joincomet.app)
  • AWS_ENDPOINT (endpoint bucket is hosted on i.e. nyc3.digitaloceanspaces.com)
  • AWS_ACCESS_KEY_ID (access key ID provided by DO Spaces/AWS)
  • AWS_SECRET_ACCESS_KEY (secret access key provided by DO Spaces/AWS)

Production

A Docker image is available at Docker Hub. joincomet. app uses DigitalOcean App Platform to deploy the Docker image. Run the Docker image with the above environment variables.


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Javascript (1,534,674
Html (430,570
Typescript (263,054
Css (214,637
Reactjs (75,452
Nodejs (55,235
Discord (10,614
Graphql (8,399
Electron (6,048
Tailwindcss (4,559
Reddit (1,340
Vite (1,007
Forum (731
Digitalocean (712
Type Graphql (128
Yarn Workspaces (119
Comet (66
Urql (40
Mikro Orm (17
Related Projects