Skip to content

Data service backing Normative's Industry CO₂ Insights calculations

License

Notifications You must be signed in to change notification settings

normative-io/sector-average-service-public

Repository files navigation

Sector Average Service

A service to query industries emissions in different regions based on the revenue. The service is connected to an optimized version of Exiobase database.

Note: The version 3 of Exiobase is used.

Installation

$ npm install

Prerequisites for running locally

make sure you have a local dir on the root of project where you keep your local .env files for different stages. e.g: local, dev, prod. run make [loc, dev, prod] to copy the right env file to the .env file on the root of the project. this file is required for the project to start.

Running in container

this project is part of public profile infrastructure and can start along with other services in a docker environment.

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Open API interface

Swagger tool is used to serve OpenApi specifications Go to http://localhost:3003/api/sector/openapi to see the Swagger API exploration UI.

Contributing

This project is maintained by Normative but currently not actively seeking external contributions. If you however are interested in contributing to the project please sign up here or come join us.

Thank you to all the people from Google.org who were critical in making this project a reality!

License

Copyright (c) Meta Mind AB. All rights reserved.

Licensed under the Apache-2.0 license