SimpleX Unofficial Catalog Frontend

Web application built on Svelte.js and Supabase for https://simplex-catalog.asriyan.me

Architecture

This repository is one of components. The entire project works on the following:

• Supabase project that stores list of all added SimpleX servers and bots and availability statuses. Code: simplex-catalog-supabase
• GitHub Actions Worker running the app what validates SMP servers and updates date in Supabase. Code: simplex-catalog-servers-validator
• GitHub Actions Worker running the app what validates bots and updates date in Supabase. Code: simplex-catalog-bots-validator
• GitHub Pages serving SPA app. Code: this repository.

Setup

Init

1. Setup simplex-catalog-supabase locally or in cloud. This is backend service for the frontend app
2. (optional) Setup Google Analytics
3. (optional) Setup Sentry account and create Svelte project
4. Create ENV_FILE_CONTENT repository variable and copy content of filled by you .env file in it
5. Setup simplex-catalog-servers-validator
6. Setup simplex-catalog-bots-validator

Local development

1. Install docker
2. Install dependencies:

   make dev_install

Now you can run the dev server locally:

make dev_serve

Generate prod bundle

make prod_build_bundle

GitHub Actions

• Each push to master triggers deployment to production
• Make sure that ENV_FILE_CONTENT repository variable is filled