Developer introduction

The Search-a-licious project is centered around a few main components:

• The API, using FastAPI, that you find in app folder. See it's ref documentation
• The web components to build your UI, using Lit that you find in frontend folder. See Explain frontend
• Docker compose for deployment, see docker-compose.yml and docker/ folder

We use three main components:

• Elasticsearch for the search engine¹
• [Redis] for event stream²
• Vega for the charts

see Explain Architecture for more information.

Getting started

See Install the project locally for development

Development tips

• How to debug the backend

---

1. Open Search is also a desirable target, contribution to verify compatibility and provide it as default would be appreciated. ↩

2. an alternative to Redis for event stream would also be a desirable target. ↩