https://github.com/Open-Sustainability-Index/open-sustainability-index-backend

Backend and API routes for Open Sustainability Index
https://github.com/Open-Sustainability-Index/open-sustainability-index-backend

remix supabase swagger typescript vite

Last synced: about 2 months ago
JSON representation

Backend and API routes for Open Sustainability Index

• Host: GitHub
• URL: https://github.com/Open-Sustainability-Index/open-sustainability-index-backend
• Owner: Open-Sustainability-Index
• License: agpl-3.0
• Created: 2024-04-17T12:50:11.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-10-29T14:16:02.000Z (2 months ago)
• Last Synced: 2024-10-29T14:48:36.737Z (2 months ago)
• Topics: remix, supabase, swagger, typescript, vite
• Language: PLpgSQL
• Homepage: https://api.opensustainabilityindex.org/v1/companies?api-key=demo&limit=10&offset=0
• Size: 1.11 MB
• Stars: 7
• Watchers: 2
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• open-sustainable-technology - Open Sustainability Index - An open, transparent, wikipedia-like sustainability database - aiming to accelerate comparable corporate sustainability data. (Emissions / Carbon Intensity and Accounting)

README

        
# Open Sustainability Index (backend)

## Introduction for new contributors

See the README on https://github.com/Open-Sustainability-Index

## How to run

	npm run dev

## Set up local Supabase development

	cd ./supabase

	npx supabase start

Take note of `API URL` and `anon key`. You can also use this to get API keys and URLs:

	npx supabase status

### Development environment

Supabase web admin: http://127.0.0.1:54323/

Postgres connection string for TablePlus/Postico: `postgresql://postgres:postgres@localhost:54322/postgres`

### Get schema and data from cloud database

	npx supabase db pull  # Pull down local db schema from cloud db

	npx supabase db push  # Push up your local db schema to cloud db

Get data:

	npx supabase db dump --data-only -f db_data.sql

	psql --single-transaction --file db_data.sql --dbname 'postgresql://postgres:postgres@localhost:54322/postgres'

### Creating migration of database changes from local machine to server

Edit your local database, then run:

	npx supabase db diff -f [migration-name]

	# Then normally run: npx supabase db push

Running a migration locally:

	npx supabase migration up

Reset database and apply current migrations:

	npx supabase db reset

## API

Note: use `&api-key=demo`, or set it as a Bearer token in the header.

- Companies:

	- List: http://localhost:5173/v1/companies?sort=company_name&order=asc&limit=20&offset=0&api-key=demo

	- List by tag: http://localhost:5173/v1/companies?tags=omx120&api-key=demo

	- Company: http://localhost:5173/v1/companies/ap-moller-maersk?api-key=demo

	- Company all years: http://localhost:5173/v1/companies/ap-moller-maersk/all-years?api-key=demo

- Industries: http://localhost:5173/v1/industries?api-key=demo

- Search: http://localhost:5173/v1/search?query=Maersk&sort=name&order=asc&api-key=demo

Live API on https://api.opensustainabilityindex.org/

## Structure

- /app

	- /components

			- /common

			- /input

			- /[area specific]

	- /routes

		- /api

	- /hooks (incl context)

	- /services (business logic)

	- /utils (smaller utils)

- /loaders

		- articles.ts

- /config

- /public

- /db

	- /migrations

## SQL functions

	SELECT * FROM companies(

		0,                  -- offset_value

		20,                 -- limit_value

		'name',             -- sort_by

		'asc',              -- sort_order

		--  'Technology',   -- industry_filter

		--  true,           -- near_term_filter

		--  'Type A',       -- commitment_type_filter

		--  'Active',       -- commitment_status_filter

		--  'Target 1'      -- target_target_filter

		--  'omx120'        -- tags_filter

	);

-- v2:

	SELECT * FROM companies_v2(

		0,                  -- offset_value

		20,	                -- limit_value

		'name',             -- sort_by

		'asc'               -- sort_order

		--  'Technology',   -- industry_filter

		--  true,           -- near_term_filter

		--  'Type A',       -- commitment_type_filter

		--  'Active',       -- commitment_status_filter

		--  'Target 1'      -- target_target_filter

		--  ??              -- emissions_required

		--  'omx120'        -- tags_filter

	);

Get SQL code:

	SELECT pg_get_functiondef('companies_v2'::regproc);