syntaqx/api repository overview
API
My Personal API for things I want to API.
Getting started
Clone the repository
git clone [email protected]:syntaqx/api && cd "$(basename "$_")"
Starting the environment
docker compose up -d --build
Note
You may prefer to develop using `go` directly. You can reference the `Dockerfile` for necessary steps to run the code on your system, but given the steps will be different for each host operating system and their versions, this route will remain undocumented.
Binding to localhost
In order to access the container ports over localhost you'll need to override the default
compose.yml port values and specify your preferred host port. To use the default
values, or quickly populate the file, simply:
cp compose.override.example.yml compose.override.yml
Note
Any changes made to the `compose.override.yml` will be ignored by git, to feel free to use this to make any environment-specific changes or overrides without affecting others local settings.
Then (re)start your containers with the new port bindings:
docker compose up -d
Tag summary
Content type
Image
Digest
sha256:e628ccbac…
Size
17.6 MB
Last updated
about 2 years ago
docker pull syntaqx/api