Tab

💰 Yes. We have to drink. But we also have to pay. This does the paying part.

Not to be confused with Tap.

Development

To provide a consistent experience on every system, docker compose is used.

Using Docker and Make (recommended)

Linux/Unix

1. Install Docker and Docker Compose (if not already included).
2. Start the development server.

   make up

   This will start a development server on http://localhost:3000. Cancelling this command will leave tab running in the background. You can stop it using make down.

3. Create the database.

   make migrate

   The development setup uses a SQLite 3 database, which can be found under /db/development.sqlite3.

4. Generate openapi spec.

   make swagger

   Required for the http://localhost:3000/api-docs page.

5. Start a development shell.

   make shell

   Here you can invoke ./bin/rails or ./bin/rake for e.g. code generation.

See the Makefile for all commands.

Adding clients

A client can see and modify balances of other users.

To add a client, connect to the server, cd production/current, then run RAILS_ENV=production bundle exec rails console. Then you can add clients with client = Client.create name: "Tap".

If you want the client to be able to make transactions, run: client.add_role :create_transactions in the console.