Grist is a modern relational spreadsheet. It combines the flexibility of a spreadsheet with the
robustness of a database to organize your data and make you more productive.
⚠️ This repository is in a pre-release state. Its release will be announced when it has
all the planned components, and a solid independent build and test set-up. Currently, stand-alone
server functionality is present, along with a single-user web client.
This repository, grist-core, is maintained by Grist
Labs. Our flagship product, available at getgrist.com, is built from the code you see
here, combined with business-specific software designed to scale it to many users, handle billing,
etc.
If you are looking to use Grist in the cloud, head on over to getgrist.com.
The easiest way to use Grist locally on your computer is with Docker.
From a terminal, do:
docker pull gristlabs/grist
docker run -p 8484:8484 -it gristlabs/grist
Then visit http://localhost:8484
in your browser. You'll be able to create and edit documents,
and to import documents downloaded from the https://docs.getgrist.com host. You'll also be able
to use the Grist API.
To preserve your work across docker runs, provide a directory to save it in:
docker pull gristlabs/grist
docker run -p 8484:8484 -v $PWD/persist:/persist -it gristlabs/grist
Here are the steps needed:
yarn install
yarn run build:prod
yarn run install:python
yarn start
# unauthenticated grist client available at http://localhost:8484
# unauthenticated grist api available at http://localhost:8484/api/
Then you can use the Grist client, or the API. You cannot (yet) edit Grist documents
in place on your file system. All imported/created documents will appear in the docs
subdirectory.
By opening its source code and offering an OSI-approved free license,
Grist benefits its users:
This repository, grist-core
, is released under the Apache License, Version
2.0, which is an
OSI-approved free software license. See LICENSE.txt and NOTICE.txt for
more information.