Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
subiabre committed Jan 7, 2025
1 parent d560aa7 commit 1b28422
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# The v4 API
This repository holds the code for the Goteo **v4** API.

> **NOTE**: Review the trusted certificates by OpenSSL. See: https://github.com/GoteoFoundation/v4/issues/43
## Installation
This application requires [Docker](https://docs.docker.com/get-docker/) and the [Docker Compose](https://docs.docker.com/compose/install/) plugin.

Expand Down Expand Up @@ -31,7 +33,7 @@ UID=1001
GID=1001
APP_HTTP_PORT=8080
APP_HTTPS_PORT=8433
APP_HTTPS_PORT=8443
```

Then feed your custom env vars to Compose:
Expand All @@ -41,7 +43,7 @@ docker compose --env-file .env.local up -d --build

- Option B. Passing the variables through the shell.
```shell
export APP_HTTP_PORT=8080 && export APP_HTTPS_PORT=8433
export APP_HTTP_PORT=8080 && export APP_HTTPS_PORT=8443

# Dynamic user and group id
export UID=$(id -u) && export GID=$(id -g)
Expand Down Expand Up @@ -73,7 +75,7 @@ bin/docker php bin/console app:gateways:setup

## Usage

The app should be live at [http://localhost:8091](http://localhost:8091) (or your specified ports). Keep in mind that the API address is [/v4](http://localhost:8091/v4).
The app should be live at [http://localhost:8090](http://localhost:8090) (or your specified ports). Keep in mind that the API address is [/v4](http://localhost:8090/v4).

You can access a real-time build of the OpenAPI spec file for v4 at [http://localhost:8090/v4/docs.json](http://localhost:8090/v4/docs.json), to be used, for example, with API development suites such as Hoppscotch. This file will be up to date with most of your latest changes.

Expand All @@ -83,6 +85,7 @@ For quick Docker access you can use the `bin/docker` shortcut to quickly `exec`

- Login to mysql CLI: `bin/docker mariadb mysql -u goteo -pgoteo goteo`
- Debug the symfony services: `bin/docker php bin/console debug:container`
- List app custom commands: `bin/docker php bin/console list app`

## Testing

Expand Down

0 comments on commit 1b28422

Please sign in to comment.