Skip to content

Commit

Permalink
misc setup and doc tweaks
Browse files Browse the repository at this point in the history
includes snarfed/bridgy#922, among other things.
  • Loading branch information
snarfed committed Mar 16, 2020
1 parent e9c4477 commit b26601b
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 4 deletions.
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@
/*.egg-info
/l
/l3
/local/
/local3/
/local*/
circleci_token
datastore.dat
oauth_client_secret
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,9 +172,11 @@ Pull requests are welcome! Feel free to [ping me](http://snarfed.org/about) with
First, fork and clone this repo. Then, you'll need the [Google Cloud SDK](https://cloud.google.com/sdk/) with the `gcloud-appengine-python` and `gcloud-appengine-python-extras` [components](https://cloud.google.com/sdk/docs/components#additional_components). Once you have them, set up your environment by running these commands in the repo root directory:

```shell
gcloud config set project granary-demo
python3 -m venv local3
source local3/bin/activate
pip install -r requirements.txt
ln -s local3/lib/python3*/site-packages/oauth_dropins
```

Now, run the tests to check that everything is set up ok:
Expand All @@ -195,7 +197,7 @@ dev_appserver.py --log_level debug --enable_host_checking false \

Open [localhost:8080](http://localhost:8080/) and you should see the granary home page!

If you want to work on [oauth-dropins](https://github.com/snarfed/oauth-dropins) at the same time, install it in "source" mode with `pip install -e <path to oauth-dropins repo>`.
If you want to work on [oauth-dropins](https://github.com/snarfed/oauth-dropins) at the same time, install it in "source" mode with `pip install -e <path to oauth-dropins repo>`. You'll also need to update the `oauth_dropins` symlink, which is needed for serving static file assets in dev_appserver: `ln -sf <path-to-oauth-dropins-repo>/oauth_dropins`.

To deploy to production:

Expand Down
4 changes: 4 additions & 0 deletions docs/build.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
#!/bin/bash
#
# Preprocesses docs and runs Sphinx (apidoc and build) to build the HTML docs.
#
# Requires:
# brew install pandoc
# pip install sphinx (in virtualenv)
set -e

absfile=`readlink -f $0`
Expand Down
2 changes: 1 addition & 1 deletion oauth_dropins

0 comments on commit b26601b

Please sign in to comment.