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

Some edits to the flow of README.

Browse Source
This commit is contained in:
Dmitry 2020-10-29 17:54:45 -04:00 committed by GitHub
parent 9287439e5a
commit ce824aad34
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -8,13 +8,15 @@ all the planned components, and a solid independent build and test set-up. Curre
server functionality is present, along with a single-user web client. server functionality is present, along with a single-user web client.
This repository, [grist-core](https://github.com/gristlabs/grist-core), is maintained by Grist This repository, [grist-core](https://github.com/gristlabs/grist-core), is maintained by Grist
Labs. Our flagship product, available at https://www.getgrist.com, is built from the code you see Labs. Our flagship product, available at [getgrist.com](https://www.getgrist.com), is built from the code you see
here, combined with business-specific software designed to scale it to many users, handle billing, here, combined with business-specific software designed to scale it to many users, handle billing,
etc. etc.
If you are looking to use Grist in the cloud, head on over to [getgrist.com](https://www.getgrist.com).
## Opening and editing a Grist document locally ## Opening and editing a Grist document locally
The easiest way to use Grist locally is with [Docker](https://www.docker.com/get-started). The easiest way to use Grist locally on your computer is with [Docker](https://www.docker.com/get-started).
From a terminal, do: From a terminal, do:
```sh ```sh
@ -33,6 +35,24 @@ docker pull gristlabs/grist
docker run -p 8484:8484 -v $PWD/persist:/persist -it gristlabs/grist docker run -p 8484:8484 -v $PWD/persist:/persist -it gristlabs/grist
``` ```
## Building from source
Here are the steps needed:
```sh
npm install
npm run build:prod
npm run install:python
npm 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.
## Why Open Source? ## Why Open Source?
By opening its source code and offering an [OSI](https://opensource.org/)-approved free license, By opening its source code and offering an [OSI](https://opensource.org/)-approved free license,
@ -58,25 +78,6 @@ Grist benefits its users:
include Grist in your pipeline. And if a feature is missing, you can just take the source code and include Grist in your pipeline. And if a feature is missing, you can just take the source code and
build on top of it! build on top of it!
## Building from source
Here are the steps needed:
```sh
npm install
npm run build:prod
npm run install:python
npm 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.
For using hosted Grist, just head on over to <https://www.getgrist.com>.
# License # License
This repository, `grist-core`, is released under the [Apache License, Version This repository, `grist-core`, is released under the [Apache License, Version