Con Yappa

Latam’s first prize-linked savings account.

Requirements

• Docker (needed)
• Docker Compose (needed)
• Make (highly recommended)
• Poetry (highly recommended)

Install Con Yappa’s back end for local development

Create your local settings (i.e., environment variables):

make localsettings

---

Build the Docker images:

make build

---

If you want, you can drop the database (i.e., erase everything, including migrations):

docker-compose down --volumes

---

If you want, you can run the migrations manually (the next step will do it for you, though):

(The database might not be ready yet; if the command fails then try again.)

make migrate

---

Start the application:

docker-compose up

(Then, to stop the application just type ctrl-C.)

---

Kill all processes (on another terminal, if the application is still running):

docker-compose down

Wanna write some code? Follow these steps first

Create a development-friendly virtual environment:

make createvenv

---

If new dependencies are added, update your virtual environment and re-build the Docker images:

make createvenv
make build

---

If you are adding any files or folders that should be considered by Docker, unignore them at the .dockerignore. Then, re-build the images:

make build

---

Format your code with Black and iSort:

make format

Interacting with the API with Zum

There is an integrated zum.toml file that allows the developer to interact with the API using Zum. For now, there is a version collision of httpx between zum and fintoc, so zum isn't installed on the pyproject.toml as a dev-dependency, and you will probably have to empty your .venv to be able to install zum. To use zum with the API, install it using pip and run the CLI with the zum CLI interface. The zum.toml includes all the possible commands that can be used. To learn more about how to expand that file and how to read it to use the CLI, head to the official documentation, or contact @daleal.