annon.api

(โ˜… 333)

Configurable API gateway that acts as a reverse proxy with a plugin system.

  • .dockerignore
  • .ebert.yml
  • .env
  • .formatter.exs
  • .gitignore
  • .gitmodules
  • .travis.yml
  • apiary.apib
  • CONTRIBUTING.md
  • coveralls.json
  • Dockerfile
  • LICENSE.md
  • mix.exs
  • mix.lock
  • PULL_REQUEST_TEMPLATE.md
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/Nebo15/annon.api

Downloads the entire project code from GitHub to your computer.

cd annon.api

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t annon-api .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 annon-api

Runs the built image as an actual container.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
// repository documentation