DocumentCloud frontend

The main frontend for DocumentCloud, written in Svelte.

Usage

This project is a standard Node project but wrapped to run in Docker compose. In order to use this project, Squarelet and DocumentCloud (Django) must already be up and running, following the steps in their READMEs.

In order to install, run:

make install

Once the node modules have been installed, start the app with:

make dev

Set up your hosts:

echo "127.0.0.1 www.dev.documentcloud.org" | sudo tee -a /etc/hosts

Once everything is up and running, you should be able to see the website live at www.dev.documentcloud.org.

Building for production

Run make build to build the production version of the app. The project will be output in the public directory.

Architecture

See the Wiki for information on the DocumentCloud architecture.

Developing

Installing new packages

Run the relevant npm install ... command and then get the change mirrored on the Docker image by running make install.