Resemble Bank

For the impatient:

1. Prepare an environment by either:
   • Using VSCode connected to a GitHub Codespace
   • Installing prerequisites directly
2. Run the application

Overview

This repository contains an example bank written using Resemble.

The Resemble '.proto' definition can be found in the api/ directory, grouped into subdirectories by proto package, while backend specific code can be found in backend/ and front end specific code in web/.

For more information on all of the Resemble examples, please see the docs.

Prepare an environment by...

Using VSCode connected to a GitHub Codespace

This method requires running VSCode on your machine: if that isn't your bag, see the other environment option below.

This repository includes a Dev Container config (more about Dev Containers) that declares all of the dependencies that you need to build and run the example. Dev Containers can be started locally with VSCode, but we recommend using GitHub's Codespaces to quickly launch the Dev Container:

1. Right-click to create a Codespace in a new tab or window:
   • 
   • Important: In order to view the example's front end, you must connect your local VSCode to the codespace: you cannot use VSCode in a browser window.
2. Go to https://github.com/codespaces and click the three dots next to the codespace you just created and then click Open in Visual Studio Code.
   • You can set your default editor to VSCode for codespaces to avoid this step in the future. See these instructions for more information.

Now you're ready to run the application!

Installing prerequisites directly

Running directly on a host requires:

• A platform of either:
  • x86_64 Linux with glibc>=2.35 (Ubuntu Jammy and other equivalent-generation Linux distributions)
  • arm64 or x86_64 MacOS with MacOS>=13.0 and Xcode>=14.3
• Rye - A tool to manage python, pip, and venv.
  • If you are already familiar with Python virtual environments, feel free to use your tool of choice with pyproject.toml. Python==3.10 is required.
• Node.js
  • Including npm.
• Docker
  • Note: the example does not run "inside of" Docker, but Docker is used to host a native support service for local development.

If you are unable to meet any of these requirements, we suggest using the VSCode and Dev Container environment discussed above.

Now you're ready to run the application!

Run the application

Backend

Our backend is implemented in Python and we must install its dependencies before running it. The most notable of those dependencies is the reboot-resemble PyPI distribution, which contains both the Resemble CLI (rsm) and the resemble Python package.

Using rye, we can create and activate a virtualenv containing this project's dependencies (as well as fetch an appropriate Python version) using:

rye sync --no-lock
source .venv/bin/activate

Run the backend

Then, to run the application, you can use the Resemble CLI rsm (present in the active virtualenv):

rsm dev run

Running rsm dev run will watch for file modifications and restart the application if necessary. See the .rsmrc file for flags and arguments that get expanded when running rsm dev run.

Front end

Similar to the backend, the front end has dependencies that need to be installed before running it. Open a separate terminal/shell and do:

cd web/
npm install
npm start

If using VSCode, the page will load automatically. If not using VSCode, visit http://127.0.0.1:3000`.