typescript-aniskip-api

API for Aniskip web browser extension

Getting started

API Documentation

The documentation for the API can be found at https://api.aniskip.com/api-docs

Running the API

Prerequisites

You will need to have installed:

1. Docker

Deploying the API for production

The built images for this project can be found on Docker Hub

1. Create a docker-compose.yml file. An example one can be found here
2. Create a .env file in the same directory. An example one can be found here
3. Start the docker containers

   docker-compose up -d
   

4. Add TLS/SSL using a reverse proxy. You can use reverse proxy software like traefik or NGINX. You can easily create an NGINX config here

Running the API for development

1. Clone the repo

   git clone https://github.com/lexesjan/typescript-aniskip-api
   

2. Navigate into the cloned GitHub repository

   cd typescript-aniskip-api
   

3. Copy .env_example in the docker folder to ./docker/.env and change POSTGRES_PASSWORD
4. Run the start script

   ./docker/start.sh dev