Ribbit Reference Implementation (Backend)
The reference implementation for the backend of a broker-dealer trading application with the Alpaca Broker API. The backend is implemented using Go.
To read more about what Ribbit is, it’s use cases, how it works with Broker API, and more check out our Ribbit documentation.
You can also access the Ribbit Reference Implementation (Android) and Ribbit Reference Implementation (iOS) for a reference implementation of Ribbit’s user interface for both iOS and Android.
Caveat
This code is provided as open source for the purpose of demonstration of the Broker API usage. It is not designed for the production use and Alpaca does not offer official support of the code available in this repository.
Development Setup
Ribbit uses golang gin as webserver, and go-pg library for connecting with a PostgreSQL database.
High-level Architecture
Third Party Dependencies
The application uses the following third party apps in order to enable functionality reuse:
- Twilio Verify(Used for email/mobile verification)
- Twilio Verify API (https://www.twilio.com/docs/verify/api)
- The Application requires the Twilio Account SID under the
TWILIO_ACCOUNTvariable inenv.sample - The Application requires the Twilio Account Auth Token under the
TWILIO_TOKENvariable inenv.sample
- Plaid (Used for quickly transferring funds from your bank to Alpaca)
- Plaid feature is only currently supported for US customers. Integration with UK and EU customers is coming soon
- Plaid is used for ACH transfers to Alpaca. Check Alpaca's funding documentation for more info. Alpaca's ACH API might be helpful as well
- Environment variables (in
env.sample):PLAID_CLIENT_ID: Plaid API account IDPLAID_SECRET: Plaid authentication tokenPLAID_ENV: [sandbox|development|production]PLAID_PRODUCTS: currently, the app only needsauthto authenticate ACH transfers
- Magic Labs (Used for seemless sign up and login using a single link)
- Environment variables (in
env.sample):MAGIC_API_KEY: API key provided by Magic labsMAGIC_API_SECRET: Secret token provided by Magic labs
- Environment variables (in
- SendGrid (Used for the traditional sign up flow)
- Environment variables (in
env.sample):SENDGRID_API_KEY: API key provided by SendGrid
- Environment variables (in
Get started
Generating private keys
A simple and efficient way of generating private keys is through mkcert. To install it, go over to their repo.
After successfully installing it in your machine, run mkcert -install
# allow read write execute for current user
chmod 700 ./generate-ssl.sh
Initializing and starting the application
Run it with docker compose
docker compose up
Run it locally
Note: Change POSTGRES_HOST to localhost when running on local machine and not docker. The same goes for POSTGRES_SUPERUSER_PASSWORD, set it to empty.
# postgresql config
cp .env.sample .env
source .env
# get dependencies and run
go get -v ./...
go run ./entry/ generate_secret
# copy the cli output of the command above and replace {JWT_SECRET} with it
export JWT_SECRET={JWT_SECRET}
# create a new database based on config values in .env
go run ./entry create_db
# create our database schema
go run ./entry create_schema
# create our superadmin user, which is used to administer our API server
go run ./entry create_superadmin
# schema migration and subcommands are available in the migrate subcommand
# go run ./entry migrate [command]
# run the application
go run ./entry/main.go
Tests and coverage
Run all tests
go test -coverprofile c.out ./...
go tool cover -html=c.out
# or simply
./test.sh
Run only integration tests
go test -v -run Integration ./...
./test.sh -i
Run only unit tests
go test -v -short ./...
# without coverage
./test.sh -s
# with coverage
./test.sh -s -c
Schema migration and cli management commands
# create a new database based on config values in .env
go run ./entry create_db
# create our database schema
go run ./entry create_schema
# create our superadmin user, which is used to administer our API server
go run ./entry create_superadmin
# schema migration and subcommands are available in the migrate subcommand
# go run ./entry migrate [command]
26 Jul 2, 2022
204 Dec 28, 2022
8 Nov 14, 2021
0 Oct 20, 2021
0 Nov 1, 2021
0 Nov 3, 2021
0 Nov 5, 2021
7 Oct 17, 2022
1 Nov 14, 2021
0 Dec 4, 2021
0 Nov 27, 2021
124 Jan 3, 2023
7 May 18, 2022
0 Nov 5, 2021
0 Nov 17, 2021
0 Dec 17, 2021
0 Dec 31, 2021
3 Mar 22, 2022
0 Feb 9, 2022