Skip to content

Commit

Permalink
Merge pull request #19 from hrcn/master
Browse files Browse the repository at this point in the history
updated quickstart
  • Loading branch information
jkhartshorne committed Mar 3, 2020
2 parents 8bc82cb + 9cf6fd6 commit 3980e4a
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/source/development/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Pushkin is 100% open-source. We love it when people come together to help fix bu
1. `Client <https://github.com/pushkin-consortium/pushkin-client>`_ (:ref:`Docs <pushkin_client>`)
A module that provides simplified methods for making calls to a Pushkin API and unpacking data sent back from a worker. Note that built-in functions assume the API has corresponding default routes enabled to handle such requests.

2. `API <https://github.com/pushkin-consortium/pushkin_api>`_ (:ref:`Docs <pushkin_api>`)
2. `API <https://github.com/pushkin-consortium/pushkin-api>`_ (:ref:`Docs <pushkin_api>`)
Essentially a mini-server designed with the use case of interfacing between Pushkin Client and Pushkin Worker via RabbitMQ.

3. `CLI <https://github.com/pushkin-consortium/pushkin-cli>`_ (:ref:`Docs <pushkin_cli>`)
Expand Down
17 changes: 8 additions & 9 deletions docs/source/quickstart/gettingstarted.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ If you don't have `Homebrew <https://brew.sh/>`_, install it. Then run the follo
$ brew install Node wget
Next, install `Docker`_.
Install the pushkin-cli package globally.

Make sure Docker is running.
.. code-block:: bash
Next install the Pushkin CLI:
$ npm install -g pushkin-cli
.. code-block:: bash
Next, install `Docker`_.

$ npm install -g pushkin-cli
Make sure Docker is running.

Then, open a terminal and move to an empty directory in which to setup Pushkin.

Expand Down Expand Up @@ -89,15 +89,14 @@ For now, let's use the test database that is built by ``pushkin init site``. We
with stimuli for our experiment(s):

.. code-block:: bash
$ docker-compose -f pushkin/docker-compose.dev.yml start test_db
$ pushkin setupdb
$ docker-compose -f pushkin/docker-compose.dev.yml stop test_db
Setting up logins
--------

In ``config.js``, set ``useAuth`` to ``true`` or ``false`` depending on whether you want to have a login system or not. Note that you cannot use a forum without a login system:
In ``config.js``, located at ./pushkin/front-end/src, set ``useAuth`` to ``true`` or ``false`` depending on whether you want to have a login system or not. Note that you cannot use a forum without a login system:

.. code-block:: javascript
Expand All @@ -113,9 +112,9 @@ By default, Pushkin authenticates users using `Auth0 <http://auth0.com>`_. This

3. Give your application and a name. Select *Single Page Web App* as your application type. Click *Create*.

4. Choose the *Settings* tab. In *Allowed Callback URLs*, add ``http://localhost:3000/callback``. In *Allowed Logout URLs*, add ``http://localhost:3000/``. In *Allowed Web Origins*, also add ``http://localhost:3000/``. Click the *Save Changes* button.
4. Choose the *Settings* tab. In *Allowed Callback URLs*, add ``http://localhost/``. In *Allowed Logout URLs*, add ``http://localhost``. In *Allowed Web Origins*, also add ``http://localhost``. Click the *Save Changes* button.

Note that these URLs are used for development. When you launch the live verrsion of your website, you will need to add your public URLs. Repeat the instructions above, replacing *http://localhost:3000* with *https://YOUR-WEBSITE*. For instance, for gameswithwords, the urls are ``https://gameswithwords.org`` and ``https://gameswithwords/callback``.
Note that these URLs are used for development. When you launch the live verrsion of your website, you will need to add your public URLs. Repeat the instructions above, replacing *http://localhost* with *https://YOUR-WEBSITE*. For instance, for gameswithwords, the urls are ``https://gameswithwords.org`` and ``https://gameswithwords/callback``.

5. On the setings page, you will see a ``Domain`` (something like ``gameswithwords.auth0.com``) and a ``Client ID``. Edit ``config.js`` to match:

Expand Down

0 comments on commit 3980e4a

Please sign in to comment.