This repository contains source code for NEWS API.
To run the project localy, make sure minimum requirements are fulfilled.
- Go version 1.10 or higher
- PostgreSQL version 12
- Docker (optional) -- see here.
-
Make sure Go is installed as global command (first time only)
-
Clone this project and go to the root project to install all dependencies (first time only)
// clone the repository > git clone git@github.com:usernamesalah/news.git
-
Make sure Docker and Docker Compose is installed
-
Run
docker-compose up
While still in root project for Running Kafka , PostgreSQL , zookeper and Elastic Search with docker
We use swag to generate necearry Swagger files for API documentation. Everytime we run make build
, the Swagger documentation will be updated.
To configure your API documentation, please refer to swag's declarative comments format and examples.
To access the documentation, please visit API DOCUMENTATION.