chore: remove links to gitter
We'll now use github discussions for support.
This commit is contained in:
@@ -1,7 +1,6 @@
|
|||||||

|

|
||||||
|
|
||||||
[](https://www.patreon.com/postgrest)
|
[](https://www.patreon.com/postgrest)
|
||||||
[](https://gitter.im/begriffs/postgrest)
|
|
||||||
[](http://postgrest.org)
|
[](http://postgrest.org)
|
||||||
[](https://hub.docker.com/r/postgrest/postgrest/)
|
[](https://hub.docker.com/r/postgrest/postgrest/)
|
||||||
[](https://github.com/PostgREST/postgrest/actions?query=branch%3Amain)
|
[](https://github.com/PostgREST/postgrest/actions?query=branch%3Amain)
|
||||||
|
|||||||
+1
-4
@@ -16,9 +16,6 @@ PostgREST Documentation
|
|||||||
.. image:: https://img.shields.io/docker/pulls/postgrest/postgrest.svg
|
.. image:: https://img.shields.io/docker/pulls/postgrest/postgrest.svg
|
||||||
:target: https://hub.docker.com/r/postgrest/postgrest/
|
:target: https://hub.docker.com/r/postgrest/postgrest/
|
||||||
|
|
||||||
.. image:: https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg
|
|
||||||
:target: https://gitter.im/begriffs/postgrest
|
|
||||||
|
|
||||||
.. image:: https://img.shields.io/badge/Donate-Patreon-orange.svg?colorB=F96854
|
.. image:: https://img.shields.io/badge/Donate-Patreon-orange.svg?colorB=F96854
|
||||||
:target: https://www.patreon.com/postgrest
|
:target: https://www.patreon.com/postgrest
|
||||||
|
|
||||||
@@ -81,7 +78,7 @@ PostgREST has a focused scope. It works well with other tools like Nginx. This f
|
|||||||
Getting Support
|
Getting Support
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
The project has a friendly and growing community. For discussions, use the Github `discussions page <https://github.com/PostgREST/postgrest/discussions>`_ or join our `chat room <https://gitter.im/begriffs/postgrest>`_. You can also report or search for bugs/features on the Github `issues <https://github.com/PostgREST/postgrest/issues>`_ page.
|
The project has a friendly and growing community. For discussions, use the Github `discussions page <https://github.com/PostgREST/postgrest/discussions>`_. You can also report or search for bugs/features on the Github `issues <https://github.com/PostgREST/postgrest/issues>`_ page.
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:glob:
|
:glob:
|
||||||
|
|||||||
@@ -15,12 +15,7 @@ To make an API we'll simply be building a database. All the endpoints and permis
|
|||||||
|
|
||||||
By the end of this tutorial you'll have a working database, PostgREST server, and a simple single-user todo list API.
|
By the end of this tutorial you'll have a working database, PostgREST server, and a simple single-user todo list API.
|
||||||
|
|
||||||
Step 1. Relax, we'll help
|
Step 1. Install PostgreSQL
|
||||||
-------------------------
|
|
||||||
|
|
||||||
As you begin the tutorial, pop open the project `chat room <https://gitter.im/begriffs/postgrest>`_ in another tab. There are a nice group of people active in the project and we'll help you out if you get stuck.
|
|
||||||
|
|
||||||
Step 2. Install PostgreSQL
|
|
||||||
--------------------------
|
--------------------------
|
||||||
|
|
||||||
If you're already familiar with using PostgreSQL and have it installed on your system you can use the existing installation (see :ref:`pg-dependency` for minimum requirements). For this tutorial we'll describe how to use the database in Docker because database configuration is otherwise too complicated for a simple tutorial.
|
If you're already familiar with using PostgreSQL and have it installed on your system you can use the existing installation (see :ref:`pg-dependency` for minimum requirements). For this tutorial we'll describe how to use the database in Docker because database configuration is otherwise too complicated for a simple tutorial.
|
||||||
@@ -35,7 +30,7 @@ If Docker is not installed, you can get it `here <https://www.docker.com/get-sta
|
|||||||
|
|
||||||
This will run the Docker instance as a daemon and expose port 5433 to the host system so that it looks like an ordinary PostgreSQL server to the rest of the system.
|
This will run the Docker instance as a daemon and expose port 5433 to the host system so that it looks like an ordinary PostgreSQL server to the rest of the system.
|
||||||
|
|
||||||
Step 3. Install PostgREST
|
Step 2. Install PostgREST
|
||||||
-------------------------
|
-------------------------
|
||||||
|
|
||||||
PostgREST is distributed as a single binary, with versions compiled for major distributions of Linux/BSD/Windows. Visit the `latest release <https://github.com/PostgREST/postgrest/releases/latest>`_ for a list of downloads. In the event that your platform is not among those already pre-built, see :ref:`build_source` for instructions how to build it yourself. Also let us know to add your platform in the next release.
|
PostgREST is distributed as a single binary, with versions compiled for major distributions of Linux/BSD/Windows. Visit the `latest release <https://github.com/PostgREST/postgrest/releases/latest>`_ for a list of downloads. In the event that your platform is not among those already pre-built, see :ref:`build_source` for instructions how to build it yourself. Also let us know to add your platform in the next release.
|
||||||
@@ -91,7 +86,7 @@ If everything is working correctly it will print out its version and the availab
|
|||||||
</details>
|
</details>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
Step 4. Create Database for API
|
Step 3. Create Database for API
|
||||||
-------------------------------
|
-------------------------------
|
||||||
|
|
||||||
Connect to the SQL console (psql) inside the container. To do so, run this from your command line:
|
Connect to the SQL console (psql) inside the container. To do so, run this from your command line:
|
||||||
@@ -154,7 +149,7 @@ Now quit out of psql; it's time to start the API!
|
|||||||
|
|
||||||
\q
|
\q
|
||||||
|
|
||||||
Step 5. Run PostgREST
|
Step 4. Run PostgREST
|
||||||
---------------------
|
---------------------
|
||||||
|
|
||||||
PostgREST can use a configuration file to tell it how to connect to the database. Create a file :code:`tutorial.conf` with this inside:
|
PostgREST can use a configuration file to tell it how to connect to the database. Create a file :code:`tutorial.conf` with this inside:
|
||||||
|
|||||||
@@ -1,6 +1,5 @@
|
|||||||
# PostgREST
|
# PostgREST
|
||||||
|
|
||||||
[](https://gitter.im/begriffs/postgrest)
|
|
||||||
[](https://www.patreon.com/postgrest)
|
[](https://www.patreon.com/postgrest)
|
||||||
[](http://postgrest.org)
|
[](http://postgrest.org)
|
||||||
[](https://github.com/PostgREST/postgrest/actions?query=branch%3Amain)
|
[](https://github.com/PostgREST/postgrest/actions?query=branch%3Amain)
|
||||||
|
|||||||
Reference in New Issue
Block a user