README.md

Looking for Navigation and all services configuration?

Follow this link for docs

• All services section

chrome-service-backend

Source code repository for chrome backend

Requirements

Postgres 14 Go 1.18

Local Testing

1. Run make env. There are environment variables that are necessary for the application to start. An example of that can be found in .env.example, but a basic working env file can be created with make env

2. Run make infra. This repo also supports docker-compose up for its postgres server, but make infra is recommended to run all needed containers.

3. Run the server by using make dev If you only want to serve the static navigation files, make dev-static will serve the needed files from the api.

4. To test the service, at the moment, you are able to hit the following endpoint:

   GET http://localhost:8000/health
   GET http://localhost:8000/api/chrome-service/v1/hello-world
   

Headers

To query any endpoint, you will need a x-rh-identity header in your request.

You can use this value as an example:

eyJpZGVudGl0eSI6eyJ1c2VyIjp7InVzZXJfaWQiOiIxMiJ9fX0=

Helpful Make targets

make dev will run the service

make infra will create the db and kafka locally

make clean will tear down the database.

make generate-search-index will generate search index file

make parse-services will generate the services-generated.json file