This project aims to provide a simple back for front for ecoindex API project. It is mainly used by the ecoindex browser plugin.

It offers a way to retrieve easily the latest results for a given page, and also for the current website

It is built in Golang and Fiber to provide great performance and be as light as possible

• Docker
• Docker Compose v2
• Golang
• Fiber
• Air (live reload)
• Redis for caching

go mod download

To start the project, you first need configure your .env file and provide the url of the ecoindex API you want to reach by setting the environment variable API_URL. Default is set to https://ecoindex.p.rapidapi.com.

cp .env.dist .env

If you use production API url, you have to request an API key on RapidAPI platform. Once you get your API Key, you can set the env variable API_KEY

API_URL=https://ecoindex.p.rapidapi.com        # Or your own server url
API_KEY=your-generated-api-key                     # Optional if not production server

# You can also specify your application listening port (default is 3001)
APP_PORT=1337

You need to launch a local redis server. The simpliest way to do so is to use a docker image of redis:

docker run -d -p 6379:6379 redis

Then you can launch your project simply using air command:

air

You can also use docker compose to launch the project:

cp docker-compose.yml.dist docker-compose.yml
docker-compose up -d --build && docker-compose logs -f

You can now reach your Back For Front instance on http://localhost:3001 (regarding the APP_PORT you defined...)

The application uses a Redis cache to store the results of the API calls (only for /ecoindexes* endpoints). It is enabled by default, but you can disable it by setting the CACHE_ENABLED environment variable to false.

The cache is set to expire after 1 week (604800 seconds). You can change this value by setting the CACHE_TTL environment variable.

Endpoints /badge, /redirect and /api/results provide a refresh parameter to force the cache to be refreshed. Those endpoints also add cache-control header set to public, max-age=604800 (1 week) to allow the browser to cache the response.

GET /api/results/?url=https://www.mywebsite.com/my-page/

This is an alias of the ecoindex API Create a new task endpoint

POST /api/tasks
{
    "url": "https://www.mywebsite.com/my-page/",
    "width": 1920,
    "height": 1080
}

This is an alias of the ecoindex API Get the result of a task endpoint

GET /api/tasks/a7c3d264-62c6-4f45-b1db-51d7db31d085

This is an alias of the ecoindex API Get screenshot of a ecoindex result endpoint

GET /api/screenshot/a7c3d264-62c6-4f45-b1db-51d7db31d085

GET /health

GET /badge/?url=https://www.mywebsite.com/my-page/

GET /redirect/?url=https://www.mywebsite.com/my-page/