API For Deforestation Dashboard

Getting started

To get the server running locally:

• Clone this repo
• yarn install to install all req'd dependencies
• yarn start to start the local server

Dependencies

Express

Express is our Web Framework of choice for creating our RESTful API.

Helmet

Helmet is a middleware function we use for Express. It sets multiple headers, to make our API more secure.

Morgan

Morgan is an Express middleware function used to log every HTTP request in the console of the application. This is very useful for seeing the result of all requests going through your API.

Cors

Cors is used to enabling Cross origin resource sharing between the API and Front End. This package allows us to do it with one simple line, and acts as a middle ware function for Express.

Dotenv

Dotenv is simple, yet important. It loads variables from a .env file into process.env for our project to take use of.

Knex

Knex is an SQL query builder that we use to interact with our Database in the API.

PG

Non-blocking PostgreSQL client for Node.js. Pure JavaScript and optional native libpq bindings.

Development Dependencies

Cross-env

Cross-env is used for allowing Environment Variable setting with any platform/operating system.

Faker

Faker is used for generating random data.

Jest

Jest is meant for Javascript testing.

Supertest

Supertest is used for HTTP Assertions. We use Supertest to test all of our API Endpoints.

Nodemon

Nodemon is used for restarting your Node.js Application automatically if any of the source code changes.

Environment Variables

• DATABASE_URL PostgreSQL connection string. Provided by Heroku if you have a PostgreSQL addon.
• DB_ENV Can be set to testing, development, or production. Defaults to development.

Endpoints

GET /forest/

• Returns an array with every row in data table as an element.

• Response Example:

[
    {
        "country": "Afghanistan",
        "code": "AFG",
        "year": 1990,
        "forest_area_km": "13500",
        "country_land_area_km": "652860",
        "forest_propotion_to_land": "2.07",
        "country_population": "12249114",
        "wood_removal": "2160000",
        "total_land_usage": "0",
        "percent_protected_land": "0",
        "mean_yearly_exposure_pollution": "60.9366899697247"
    },
    ...
]

GET /forest/:year

• Returns an array with each element is an object containing a country name and a forest percentage in the year provided.

• Response Example:

[
    {
        "country": "Afghanistan",
        "forest_propotion_to_land": "2.07"
    },
    {
        "country": "Albania",
        "forest_propotion_to_land": "28.79"
    },
    {
        "country": "Algeria",
        "forest_propotion_to_land": "0.70"
    },
    ...
]

GET /forest/:year/array

• Similar to GET /forest/:year but returning a different data format.

• Response Example:

{
    "country": [
        "Afghanistan",
        "Albania",
        "Algeria",
        "American Samoa",
        "Andorra",
        ...
    ],
    "forest_propotion_to_land": [
        "2.07",
        "28.79",
        "0.70",
        "91.94",
        "34.04",
        ...
    ]
}

GET /:country

• Returns an array containing information of a country in different years.

• :country should match the country name exactly. Usually, first letter of a country name is capitalized (Ex: "Afghanistan")

• Response Example:

[
    {
        "country": "Afghanistan",
        "code": "AFG",
        "year": 1990,
        "forest_area_km": "13500",
        "country_land_area_km": "652860",
        "forest_propotion_to_land": "2.07",
        "country_population": "12249114",
        "wood_removal": "2160000",
        "total_land_usage": "0",
        "percent_protected_land": "0",
        "mean_yearly_exposure_pollution": "60.9366899697247"
    },
    {
        "country": "Afghanistan",
        "code": "AFG",
        "year": 1991,
        "forest_area_km": "13500",
        "country_land_area_km": "652860",
        "forest_propotion_to_land": "0",
        "country_population": "0",
        "wood_removal": "2210000",
        "total_land_usage": "0",
        "percent_protected_land": "0",
        "mean_yearly_exposure_pollution": "0"
    },
    ...
]

GET /:country/:year

• Returns information of a country in the given year.

• :country should match the country name exactly. Usually, first letter of a country name is capitalized (Ex: "Afghanistan")

• Response Example:

{
    "country": "Afghanistan",
    "code": "AFG",
    "year": 1990,
    "forest_area_km": "13500",
    "country_land_area_km": "652860",
    "forest_propotion_to_land": "2.07",
    "country_population": "12249114",
    "wood_removal": "2160000",
    "total_land_usage": "0",
    "percent_protected_land": "0",
    "mean_yearly_exposure_pollution": "60.9366899697247"
}