Archives/gristlabs_grist-core
1
0
Fork 0
mirror of https://github.com/gristlabs/grist-core.git synced 2024-10-27 20:44:07 +00:00
Code Issues Projects Releases Wiki Activity

(core) lightly freshen the core readme, mentioning roadmap and forums etc.

Browse Source 
Summary: This is a documentation update, and version bump on grist-core.

Test Plan: No code changes.

Reviewers: dsagal

Reviewed By: dsagal

Differential Revision: https://phab.getgrist.com/D2982
This commit is contained in:
Paul Fitzpatrick 2021-08-17 22:20:00 -04:00
parent f9630b3aa4
commit c561dad22d
4 changed files with 18 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
NOTICE.txt
View File

@ -1,5 +1,5 @@
Grist Software Grist Software
Copyright 2014-2020 Grist Labs Inc. Copyright 2014-2021 Grist Labs Inc.
This product includes software developed at This product includes software developed at
Grist Labs Inc. (https://www.getgrist.com/). Grist Labs Inc. (https://www.getgrist.com/).

20
README.md
View File

@ -13,6 +13,11 @@ here, combined with business-specific software designed to scale it to many user
etc. etc.
If you are looking to use Grist in the cloud, head on over to [getgrist.com](https://www.getgrist.com). If you are looking to use Grist in the cloud, head on over to [getgrist.com](https://www.getgrist.com).
If you are curious about where Grist is going heading,
see [our roadmap](https://github.com/gristlabs/grist-core/projects/1), drop a
question in [our forum](https://community.getgrist.com),
or browse [our extensive documentation](https://support.getgrist.com).
## Opening and editing a Grist document locally ## Opening and editing a Grist document locally
@ -44,14 +49,19 @@ yarn install
yarn run build:prod yarn run build:prod
yarn run install:python yarn run install:python
yarn start yarn start
# unauthenticated grist client available at http://localhost:8484 # grist client available at http://localhost:8484
# unauthenticated grist api available at http://localhost:8484/api/ # grist api available at http://localhost:8484/api/
``` ```
Then you can use the Grist client, or the API. You cannot (yet) edit Grist documents Then you can use the Grist client, or the API. You can view and edit Grist documents
in place on your file system. All imported/created documents will appear in the `docs` throught the client and the API. All imported/created documents will appear in the `docs`
subdirectory. subdirectory. You cannot (yet) edit Grist documents in place on your file system.
Grist does not have a login system built in. To activate one, you can configure Grist
to talk to an identity provider such as Auth0 using
[SAML](https://github.com/gristlabs/grist-core/blob/main/app/server/lib/SamlConfig.ts).
For running on your own computer, this isn't necessary, but it is important if you are
self-hosting Grist for use by a team.
## Why Open Source? ## Why Open Source?

2
app/server/lib/SamlConfig.ts
View File

@ -15,7 +15,7 @@
* Note that the code is based on the example at https://github.com/Clever/saml2 * Note that the code is based on the example at https://github.com/Clever/saml2
* *
* Expected environment variables: * Expected environment variables:
* env GRIST_SAML_SP_HOST=https://grist.tigerglobal.com * env GRIST_SAML_SP_HOST=https://<your-domain>
* Host at which our /saml/assert endpoint will live; identifies our application. * Host at which our /saml/assert endpoint will live; identifies our application.
* env GRIST_SAML_SP_KEY * env GRIST_SAML_SP_KEY
* Path to file with our private key, PEM format. * Path to file with our private key, PEM format.

2
package.json
View File

@ -1,6 +1,6 @@
{ {
"name": "grist-core", "name": "grist-core",
"version": "0.7.2", "version": "0.7.3",
"license": "Apache-2.0", "license": "Apache-2.0",
"description": "Grist is the evolution of spreadsheets", "description": "Grist is the evolution of spreadsheets",
"homepage": "https://github.com/gristlabs/grist-core", "homepage": "https://github.com/gristlabs/grist-core",