README.md

:server: Deployment

Server is deployed on

:runner: Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

:nut_and_bolt: Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm v >= 16.0.0

  npm install npm@latest -g
  

  Or by NVM

  nvm use 16
  

• ngrok

  npm install -g ngrok
  

:arrow_down: Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Clone the repo

   git clone git@github.com:kubo550/messenger-bot.git
   

2. Install NPM packages

   npm install
   

3. Create .env file

   mv .env.example .env
   

4. Enter all environment variables in .env

(back to top)

:computer: Usage

Before you start you need to create a special tunnel between your localhost and the network. Open terminal and type

./ngrok http 3000

then copy the forwarding url remeber to use HTTPS protocol and paste it to .env file as appUrl without slash at the end and as shopUrl with slash at the end. Now if you are using node v >= 16.x you can simply enter

npm run start

(back to top)

:pencil: License

This project is licensed under MIT license.

:man_astronaut: Show your support

Give a ⭐️ if this project helped you!

ℹ️ Fun Facts