This repository builds and publishes a docker container. The container is an installation of requirements of running Sefaria-Project as described on their website.
-
You can go to our fork of Sefaria-Project which contains a .devcontainer folder that tells GitHub Codespaces how to run it inside this container, as you can see in the video above. This way you can experiment and develope Sefaria on your browser without going through the lengthy installation process and cluttering your system.
-
Alternatively you can install Docker on your computer and Dev Containers extension on vscode. After opening our fork of Sefaria-Project in the vscode, a pop up gives you an option to pull this container and run the repo inside it locally in isolation which again, keeps your system clean.
-
We also use this container as a base to build a desktop app for Sefaria.
- If you have problems with Codespaces in your browser, disable adblocks, and on FireFox Disable Tracking Protection (Shield logo near the URL).
- The image is big (~3.5 Gigs) because it contains the database and the packages. The installation takes 5 or 10 minutes on Codespaces. We're working on making the image smaller and faster, see TODO bellow.
- This repo publishes the image to ghcr (GitHub Container Registry), link on the right hand side of this page.
- The main script that builds the images is install_dependencies.sh
- All suggestions are welcomed, open an issue.
- This is still an ongoing experimental and unofficial project.
- See whether we can delete these: /data/db/journal /data/db/diagnostic.data
- Examine ways to make the image smaller (Use alpine instead of debian, Multi-stage builds) and reduce the Dev Containers start-up time
- Use
npm run watch-clientandnpm run watchin .devcontainer and test whether changing code results in change in the preview, realtime.