diff --git a/.gitignore b/.gitignore index 79aba26..3a1bea6 100644 --- a/.gitignore +++ b/.gitignore @@ -13,7 +13,6 @@ # misc .DS_Store -.env .env.local .env.development.local .env.test.local diff --git a/README.md b/README.md new file mode 100644 index 0000000..be710bf --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# Mango Alerts Server + +Backend logic for the mango alerts provider + +## Usage + +Run ```yarn``` to install dependencies + +```bash +yarn +``` + +An example ```.env``` file - +``` +DB_USER= +DB_PASS= +DB_HOSTS= +DB= +DB_OPTIONS= +PORT=3010 +TWILIO_ACCOUNT_SID= +TWILIO_AUTH_TOKEN= +TWILIO_PHONE_NUMBER= +MAIL_USER= +MAIL_PASS= +TG_TOKEN= +```