CRDT (gsheet, etc.) based documentation collaboration pipeline to generate editable (docx, odt, etc.) and printable (pdf, etc.) output from input data
- Create a
Google Service Account
. Download theGoogle Service Account Credential
file and rename it tocredential.json
# copy the credential.json file and paste it to ./ghseet-to-json/conf/
cp </path/to/credential.json> <path/to/doculaboration>/ghseet-to-json/conf/
# in the project root folder
# rename the gsheet-to-json/conf/config.yml.dist to gsheet-to-json/conf/config.yml
mv gsheet-to-json/conf/config.yml.dist gsheet-to-json/conf/config.yml
mv json-to-context/conf/config.yml.dist json-to-context/conf/config.yml
mv json-to-docx/conf/config.yml.dist json-to-docx/conf/config.yml
mv json-to-latex/conf/config.yml.dist json-to-latex/conf/config.yml
mv json-to-odt/conf/config.yml.dist json-to-odt/conf/config.yml
Prerequisite:
- Setup project credential and config
- Install docker
# in the project root
docker compose up --build --detach
# you will see a service running on port https://localhost:8200
# you will see a website running on port https://localhost:8300
There is .env
file in the project root. Modify the variables to customize the application according to your deployment preferences
Prerequisite:
- Setup project credential and config
- Install docker
# in the project root
docker compose up --build --detach
# you will see a service running on port https://localhost:8200
# you will see a website running on port https://localhost:8300
- gsheet-to-json is for generating json output from gsheet data. The output json is meant to be fed as input for document generation components of the pipeline. See
gsheet-to-json/README.md
to learn more - json-to-docx is for generating docx (WordML) documents. See
json-to-docx/README.md
to learn more - json-to-odt is for generating odt (OpenOffice Text) documents. See
json-to-odt/README.md
to learn more - json-to-latex is for generating LaTex for generating printable outputs. See
json-to-latex/README.md
to learn more - json-to-context is for generating ConTeXt for generating printable outputs. See
json-to-context/README.md
to learn more
- api is for api service(FastAPI) application. See
api/README.md
to learn more - ui is for frontend(flutter) application. See
ui/README.md
to learn more