Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/technologiestiftung/giessdenkiez-de-postgres-api

API for giessdeniez.de to communicate with our postgres DB running on vercel.com
https://github.com/technologiestiftung/giessdenkiez-de-postgres-api

berlin citylab-berlin giessdenkiez-de open-data trees

Last synced: 30 days ago
JSON representation

API for giessdeniez.de to communicate with our postgres DB running on vercel.com

Host: GitHub
URL: https://github.com/technologiestiftung/giessdenkiez-de-postgres-api
Owner: technologiestiftung
License: mit
Created: 2020-02-06T13:20:49.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2024-10-29T11:49:25.000Z (about 2 months ago)
Last Synced: 2024-10-29T13:30:59.102Z (about 2 months ago)
Topics: berlin, citylab-berlin, giessdenkiez-de, open-data, trees
Language: TypeScript
Homepage: https://giessdenkiez-de-postgres-api.vercel.app
Size: 6.55 MB
Stars: 3
Watchers: 12
Forks: 12
Open Issues: 21
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

![](https://img.shields.io/badge/Built%20with%20%E2%9D%A4%EF%B8%8F-at%20Technologiestiftung%20Berlin-blue)

# Giess den Kiez API based on Supabase

Supabase setup for Giess den Kiez

🚨 Might become part of the [giessdenkiez-de](https://github.com/technologiestiftung/giessdenkiez-de) repo eventually.

## Prerequisites

- [Supabase](https://supabase.com) Account
- Supabase CLI install with brew `brew install supabase/tap/supabase`
- [Docker](https://www.docker.com/) Dependency for Supabase

## Setup

### Supabase (local)

```bash
git clone [email protected]:technologiestiftung/giessdenkiez-de-postgres-api.git
cd ./giessdenkiez-de-postgres-api
npm ci
# supabase needed for local development
supabase login
# Check if docker is running
docker --version
# then run
supabase start
# After a few minutes you will have a local supabase instance running with
# - Postgres DB at postgrsql://postgres:postgres@localhost:5432/postgres
# - Postgrest API at http://localhost:54321 a rest api for your db
# - Supabase Studio at http://localhost:54323 a gui for your db
# - Other cool things we currently don't use
# The Database will already have some seeded trees in Berlin

# Create .env file and populate with ENV variables from the supabase start command
# You can always get the values again by running `supabase status`
cp .env.example .env
# SERVICE_ROLE_KEY=...
# SUPABASE_URL=...
# SUPABASE_ANON_KEY=...
# SUPABASE_MAX_ROWS=1000
```

### Environments and Variables

In the example code above the Postgres database Postgrest API are run locally. You **SHOULD NOT** use production variables in your local or CI environments. The tests will modify the database and also truncate tables through the API and also with direct calls.

Again. Be a smart developer, read https://12factor.net/config, https://github.com/motdotla/dotenv#should-i-have-multiple-env-files and never ever touch production with your local code!

### Supabase

You can sign up with the request below. You will get an access token to use in your requests.

```bash
curl --request POST \
--url http://localhost:54321/auth/v1/signup \
--header 'apikey: ' \
--header 'content-type: application/json' \
--header 'user-agent: vscode-restclient' \
--data '{"email": "[email protected]","password": "1234567890"}'
```

```bash
curl --request POST \
--url http://localhost:8080/post/adopt \
--header 'authorization: Bearer ' \
--header 'content-type: application/json' \
--data '{"tree_id":"_01","uuid": ""}'

```

The user id will be removed in future versions since the supabase SDK can get the user id from the access token and each token is bound to a specific user.

## Tests

Locally you will need supabase running and a `.env` file with the right values in it.

```bash
cd giessdenkiez-de-postgres-api
supabase start
# Once the backaned is up and running, run the tests
# Make sure to you habe your .env file setup right
# with all the values from `supabase status`
npm test
```

On CI the Supabase is started automagically. See [.github/workflows/tests.yml](.github/workflows/tests.yml)

To run the tests for the Supabase Edge Functions, execute locally:

```bash
cd giessdenkiez-de-postgres-api
docker run -p 1025:1025 mailhog/mailhog
supabase start
supabase functions serve --no-verify-jwt --env-file supabase/.env.test
deno test --allow-all supabase/functions/tests/submit-contact-request-tests.ts --env=supabase/.env.test
```

## Supabase

### Migrations and Types

- Run `supabase start` to start the supabase stack
- make changes to your db using sql and run `supabase db diff --file --schema public --use-migra` to create migrations
- Run `supabase gen types typescript --local > ./_types/database.ts` to generate typescript types for your DB.

### Deployment

- Create a project on supabase.com
- Configure your GitHub actions to deploy all migrations to staging and production. See [.github/workflows/deploy-to-supabase-staging.yml](.github/workflows/deploy-to-supabase-staging.yml) and [.github/workflows/deploy-to-supabase-production.yml](.github/workflows/deploy-to-supabase-production.yml) for an example. We are using actions environments to deploy to different environments. You can read more about it here: https://docs.github.com/en/actions/reference/environments.
- Needed variables are:
- `DB_PASSWORD`
- `PROJECT_ID`
- `SUPABASE_ACCESS_TOKEN`
- **(Not recommended but possible)** Link your local project directly to the remote `supabase link --project-ref ` (will ask you for your database password from the creation process)
- **(Not recommended but possible)** Push your local state directly to your remote project `supabase db push` (will ask you for your database password from the creation process)

#### Supabase Auth

Some of the requests need a authorized user. You can create a new user using email password via the Supabase API.

```bash
curl --request POST \
--url http://localhost:54321/auth/v1/signup \
--header 'apikey: ' \
--header 'content-type: application/json' \
--data '{"email": "[email protected]","password": "1234567890"}'
```

This will give you in development already an aceess token. In production you will need to confirm your email address first.

A login can be done like this:

```bash
curl --request POST \
--url 'http://localhost:54321/auth/v1/token?grant_type=password' \
--header 'apikey: ' \
--header 'content-type: application/json' \
--data '{"email": "[email protected]","password": "1234567890"}'
```

See the [docs/api.http](./docs/api.http) file for more examples or take a look into the API documentation in your local supabase instance under http://localhost:54323/project/default/api?page=users

#### Supabase Edge Functions
To run the Supabase Edge Functions locally:

- Setup the .env file in [supabase/.env](supabase/.env) according to [supabase/.env.sample](supabase/.env.sample)
- Note: The env variables `SUPABASE_SERVICE_ROLE_KEY` and `SUPABASE_URL` are injected automatically and can't be set the in the [supabase/.env](supabase/.env) file. If you want to overwrite them, you have to rename the environment variables to not start with `SUPABASE_`. For reference, see: https://supabase.com/docs/guides/functions/secrets
- With the environment variables setup correctly, execute `supabase functions serve --no-verify-jwt --env-file supabase/.env`

To deploy the Edge Functions in your linked remote Supabase project, execute:
- `supabase functions deploy`
- Make sure that you set the proper environment variables in the remote Supabase project too

## Tests

Locally you will need supabase running and a `.env` file with the right values in it.

On CI the Supabase is started automagically. See [.github/workflows/tests.yml](.github/workflows/tests.yml)

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

_{Fabian Morón Zirfas}
💻 📖

_Fabian
💻 📖

_warenix
💻 📖

_{Daniel Sippel}
📖

_{Sebastian Meier}
💻

_{Lucas Vogel}
📖

_{Dennis Ostendorf}
👀

_{Julia Zet}
👀

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

## Credits

A project by:

Supported by:

[gdk-supabase]: https://github.com/technologiestiftung/giessdenkiez-de-supabase/
[supabase]: https://supabase.com/