search

asetalias / amibot

A Whatsapp bot for Amizone. Powered by the go-amizone API
MIT License
25 stars 16 forks source link

docs: Add a contribution guide #13

Closed khardikk closed 1 year ago

khardikk commented 1 year ago

Work done in this PR ->

  1. Created a separate folder for contribution docs
  2. Added the contribution.md file
ditsuke commented 1 year ago

Things to be covered:

  1. WhatsApp token
  2. MongoDB
    • Create a DB on MongoDB Atlas (or locally)
  3. Node version (18+ -- use nvm for easy setup)
  4. Make .env file by copying .env.sample and populating whatsapp token, VERIFY_TOKEN (for whatsapp webhook) and mongodb details
  5. Start project with yarn start or yarn dev.
  6. Install ngrok, create account on https://ngrok.com, login and expose local the local amibot instance with ngrok http 3000 --region us (the region is important -- facebook currently blocks other ngrok regions.

/cc @hady68

khardikk commented 1 year ago

@ditsuke working on it

khardikk commented 1 year ago

@ditsuke have made the changes, have a look.

khardikk commented 1 year ago

Changes from the review done. @ditsuke