Ambuda is an online Sanskrit library whose mission is to make Sanskrit literature accessible to all. This repository contains Ambuda's core code, and this README will show you how to build it.
The quickest way to run Ambuda on your computer is to use docker compose from your command line.
- You can install
docker composethrough either the Docker website or your favorite package manager. If you have a Unix machine and don't like Docker Desktop, we recommend Colima.
Once you have docker configured, starting the site is simple:
make ambuda-dev
This command will do the following:
-
Build an Ambuda Docker image. This will likely take a few minutes the first time it runs, but it will be substantially faster on subsequent runs.
-
Start Ambuda's main services: the web server, a Celery pool for background tasks, and Redis for Celery interop.
-
Initialize a Sqlite database with sample data. Data is persisted to the
data/directory and survives across restarts. -
Set up hot reloading for Python, CSS, and JavaScript.
-
Start the web server at http://localhost:5000.
To quit, press Ctrl+C to stop all services.
(Under revision.)
(Under revision.)
A full technical reference for this repository can be found here:
https://ambuda.readthedocs.io/en/latest/
It includes installation instructions, architecture notes, and other reference documentation about Ambuda's technical design.
For details on how to contribute to Ambuda, see CONTRIBUTING.md. We also
strongly recommend joining our Discord channel, where we have an
ongoing informal discussion about Ambuda's technical problems and roadmap.