zsevic / sportista-chatbot

Messenger chatbot for managing sports activities

sportista-chatbot

Messenger chatbot for managing sports activities

Getting started

Prerequisites

• Node version 14
• Local PostgreSQL database
• Local Redis instance

Setup

• Local setup

git clone https://github.com/zsevic/sportista-chatbot
cd sportista-chatbot
cp .env.sample .env # change values after copying
npm i
pg_ctl -D /usr/local/var/postgres restart
redis-server
npm run start:dev

• Chatbot setup for local usage

npx ngrok http 3000
export MESSENGER_EXTENSIONS_URL=<URL>
npm run messenger-profile:set
echo "Y" | npm run messenger-webhook:set <URL>/webhooks/messenger

Build

npm run build
npm start

Linting

npm run lint
npm run lint:fix

Testing

npm test

Migrations

npm run migration:generate <MIGRATION_NAME>
npm run migrate
npm run migrate:down

API documentation

Generated at /api-docs endpoint

Technologies used

• Node.js, TypeScript, NestJS, Bottender, Redis, TypeORM