This repository has been archived by the owner on Jul 31, 2023. It is now read-only.

Name		Name	Last commit message	Last commit date
parent directory ..
src		src
.dockerignore		.dockerignore
.env-example		.env-example
.env.example		.env.example
.gitignore		.gitignore
Dockerfile		Dockerfile
LICENSE		LICENSE
README.md		README.md
docker-compose.prod.yml		docker-compose.prod.yml
docker-compose.yml		docker-compose.yml
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json

README.md

Informatif API

The API backend for Informatif. The main website is hosted here.

Setup instructions

Install Docker Engine.
Install Docker Compose.
Copy .env.example to .env and fill in actual values of the environment variables.

Environment variables

There are 2 environment variables:

GLOBAL_NEWS_API_KEY (get the API key here)
PORT (choose a port to run the server on)

Running the server

There are 2 modes of running the server:

Development
Production

Running in development

Run npm run dev to start a development server with hot reloading.

Running in production

Run npm start to start a production server.