Skip to content
RISER

Get your computer ready

You do not need a real boiler or controller to work on RISER. You can run the whole thing on a laptop. Here are the tools you need first.

Tools to install

Section titled “Tools to install”
  • Python 3.11 or newer. This runs the agent and the backend.
  • Node.js 20 or newer. This runs the web app and the website.
  • PostgreSQL 16. This is the database the backend uses.
  • Git. This downloads the code and saves your changes.
  • Make (optional but handy). This runs short commands for you.

On a Mac, you can install most of these with Homebrew:

Terminal window
brew install python@3.11 node postgresql@16 git
brew services start postgresql@16

Get the code

Section titled “Get the code”

Use Git to copy the project to your computer:

Terminal window
git clone https://github.com/celaya-solutions/RISER.git
cd RISER

Make the databases

Section titled “Make the databases”

The backend needs two databases. One is for real use. One is for tests.

Terminal window
psql -d postgres -c "CREATE ROLE riser LOGIN PASSWORD 'riser' SUPERUSER;"
psql -d postgres -c "CREATE DATABASE riser OWNER riser;"
psql -d postgres -c "CREATE DATABASE riser_test OWNER riser;"

A role is just a user inside the database. We named ours riser.

Install the project

Section titled “Install the project”

This one command sets up Python and installs the agent and the backend:

Terminal window
make install

This makes a folder called .venv. That is a virtual environment. It is a private box that holds the exact tools this project needs. It keeps the project from messing with other projects on your computer.

Check that it worked

Section titled “Check that it worked”

Run the tests. If they pass, you are ready.

Terminal window
make lint    # checks the code style
make migrate # sets up the database tables
make test    # runs all the tests

If you see “passed” and no red errors, great. Move on to Run it on your computer.