Skip to content

Commit

Permalink
refer to tosdr/h#1
Browse files Browse the repository at this point in the history
  • Loading branch information
michielbdejong committed Jun 3, 2024
1 parent d28a040 commit 01cde51
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,8 @@ H is the Hypothesis web service and api.

1. To use it with Phoenix, clone [our fork of H](https://github.com/tosdr/h) into the same directory as the Phoenix clone, and `cd h/`. **The correct branch to work from is the *phoenix-integration* branch.**

**ATTENTION**: Due to [an issue with pip-tools](https://github.com/tosdr/edit.tosdr.org/issues/1156) you might need to use the *do-staging* branch instead.

**ATTENTION**: The official documentation for installing H is [here](https://h.readthedocs.io/en/latest/developing/install/). Please also consult these docs as needed.

Note the prerequisites:
Expand All @@ -134,8 +136,8 @@ H is the Hypothesis web service and api.

**If pyenv has trouble finding the python binary**, you may need to add configuration to `.zshrc`, as documented [here](https://stackoverflow.com/questions/51863225/pyenv-python-command-not-found).

5. `make services`, which launches the docker services needed to run H.
7. `make dev`
2. `make services`, which launches the docker services needed to run H.
3. `make dev`

If this is your first time, `make dev` will install the dependencies. To do so, it requires both *node* and *yarn*.

Expand All @@ -148,12 +150,12 @@ H is the Hypothesis web service and api.
You will have to exit and restart `tox` whenever changes are made to the code. Additionally, in debug mode, certain functionalities may be restricted. You will not be able to create and persist annotations from the client if H is running in debug mode, for example.

To launch the shell and poke around in the database, run `make shell`.
9. Create an admin user from the shell
4. Create an admin user from the shell

You will need an admin user to set up OAuth between H and the Hypothesis client.

Follow [these instructions](https://h.readthedocs.io/en/latest/developing/administration/).
7. Log in as admin, and configure OAuth
5. Log in as admin, and configure OAuth

Instructions [here](https://h.readthedocs.io/en/latest/developing/integrating-client/).

Expand Down
6 changes: 4 additions & 2 deletions staging-deploy.sh
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,11 @@ source ~/.bashrc
# Hypothesis
git clone https://github.com/tosdr/h
cd h
git checkout do-staging
echo Note this will take several minutes...
pyenv install 3.8.12
pyenv install 3.11.7
pyenv init
pyenv shell 3.8.12
pyenv shell 3.11.7
python -m pip install -rrequirements/dockercompose.txt
make services
make dev

0 comments on commit 01cde51

Please sign in to comment.