An open API service indexing awesome lists of open source software.

https://github.com/ohager/signum-twitter-tipbot


https://github.com/ohager/signum-twitter-tipbot

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

          

# Signum Twitter Tipbot

# Development

## Prerequisites

This bot needs a database connected to it. This project uses [Prisma](https://prisma.io) as DB abstraction layer.
The original version uses the DBaaS [Planetscale](https://planetscale.com), but you may connect to other RDMS, i.e. Postgres, Sqlite, MariaDB etc

## Planetscale Migrations

> The scripts for database migration are exclusively for Planetscale. When using another database other scripts need to be used.

Each time the database model needs to be adjusted, i.e. the `schema.prisma` changed, you simply run `yarn db:update`.
This updates the configured database (configure in `.env`), which should always be the __non-production__ database.
With Planetscale you use - similar to git - branches, which can be merged to other branches then.
1. Open a PR with `yarn db:deploy-request `
2. If 1 was successful and tests work as expected run `yarn db:deploy `, where `number_of_dr` is the number returned by 1

# Design

## User Input/Output

![Flowcharts - Page 1(1)](https://user-images.githubusercontent.com/39196313/194147904-721d4860-846d-4159-973e-4a6b9c41b699.png)