ShipBit/slickgpt

HowTo: Self-host without Firebase / Share feature

Open

#6 opened on Mar 23, 2023

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Svelte (91 forks)auto 404
documentationgood first issueself-hosting

Repository metrics

Stars
 (474 stars)
PR merge metrics
 (PR metrics pending)

Description

The share feature in SlickGPT requires a database because we somehow have to pass the Chat object from client A to client B.

The project is currently set up to use a Firebase Realtime database as easy "JSON dump storage".

Create a branch and some documentation where the Share feature can easily be disabled and all Firebase dependencies (mostly the env vars) are removed from SlickGPT so that devs can run their own instance quicker and with less hassle in case they don't need to share chats.

Also document more clearly which code devs would have to edit to use another database provider than Firebase (which is basically just the share endpoint)

Contributor guide

Research direction
Review the share endpoint at src/routes/api/share/+server.ts and identify all Firebase environment variables. Document how to disable the share feature or replace Firebase with another database by editing that file and removing Firebase dependencies.
Tech stack
sveltenodejs
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitSvelteNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65