SpellarBot/wilcuma-api

An idea from the OSMUS Spring Hackathon to build tasking workflow around volunteer "welcomers" who send messages through OSM's messaging system - Backend API

β˜… 0Forks 0JavaScriptGitHub β†—Compare

README

Wilcuma - OSM Welcomer API

πŸ’‘ An idea from the OSMUS Spring Hackathon to build tasking workflow around volunteer "welcomers" who send messages through OSM's messaging system. This tool would tell give them a list of new signups in their area either location or interest (based on hashtags).

πŸ—“ This project is just the very early beginnings of a backend, with tools to injest the dataset from the Slackbot into a database with an API on top.

Key Points

  • Welcomers would manually message users through OSM (this is just a tasking tool, not something automated πŸ˜‡)
  • Lots still to figure out πŸ§ β›ˆβ°

TODO

  • Finish Authentication Setup πŸ”’
  • Finalize API and Documentation πŸ“ƒ
  • Entire frontend application πŸ˜¬πŸ‹πŸ»β€
  • authorization/admins/moderation πŸ‘©β€πŸ’ΌπŸ‘¨β€πŸ’Ό

Notes

This is a Node + Express app with a GraphQL server wired to a PostgreSQL database

Development

Initialize the database

Uses Docker and Docker Compose

docker volume create --name=wilcuma-db-data
docker-compose up -d db
./run-knex.sh migrate:latest

Run locally

yarn install
cp .dev.env .env
yarn run dev

Add data

Loads the latest data from the Slackbot

node ./src/update-signups.js

Run with Docker

docker-compose up

Trying it out

Go to http://localhost:4010/api and enter a GraphQL query like

query {
  signups {
    id
    name
    changeset
  }
}

Contributors

kriscarle

Issues