Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mostafa8026/tribe-telegram-app
This repository integrate Tribe api (https://www.npmjs.com/package/@tribeplatform/gql-client) with telegram.
https://github.com/mostafa8026/tribe-telegram-app
nestjs nodejs typescript
Last synced: 2 months ago
JSON representation
This repository integrate Tribe api (https://www.npmjs.com/package/@tribeplatform/gql-client) with telegram.
- Host: GitHub
- URL: https://github.com/mostafa8026/tribe-telegram-app
- Owner: mostafa8026
- Created: 2022-04-04T16:13:00.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-06-14T06:58:47.000Z (over 2 years ago)
- Last Synced: 2024-10-12T18:21:52.484Z (3 months ago)
- Topics: nestjs, nodejs, typescript
- Language: TypeScript
- Homepage:
- Size: 984 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](http://commitizen.github.io/cz-cli/)
# TribeTelegramApp
This repository integrate Tribe api (https://www.npmjs.com/package/@tribeplatform/gql-client) with telegram.
## How to start developing
Fist copy .env.sample to .env file and fill it with propert values. You can simply create a database and provide it's name inside `TYPEORM_DATABASE`, set `TYPEORM_SYNCHRONIZE` to true and then start the api with `yarn dev` for a dev server. Navigate to http://localhost:3333/. The app will automatically reload if you change any of the source files.
For testing the webhook you can simple use [ngrok](https://ngrok.com/). Once you installed it and configured it with your access token, you can create a tunnel with this command:
```
$ ngrok http 3333
```
After that you can provide the generated link to the tribe webhook panel. Have a wonderful coding exprience!
NOTE: use `yarn run commit` to commit your changes. this repo is commitizen friendly.
## Build
Run `yarn build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
## Deploy
To deploy by docker you can simple run this command:
```
docker-compose -f tools/devops/deploy/docker-compose.yaml up --build -d
```
Be sure that services work correctly by looking at the logs:
```
docker-compose -f tools/devops/deploy/docker-compose.yaml logs -f
```
**Don't forget** to provide DB password, tribe api configs and your bot config (that you registered by the help of [botfather](https://telegram.me/BotFather)) with a .env file at the root, sample .env file:
```
# TOKEN
GRAPHQL_URL="https://app.tribe.so/graphql"
CLIENT_ID = ""
CLIENT_SECRET = ""
SIGNING_SECRET = ""
NETWORK_ID = ""
MEMBER_ID = ""
# BOT, get these from @botfather
TELEGRAM_BOT_TOKEN = ""
TELEGRAM_BOT_USERNAME = ""
# DATABASE CONFIG
TYPEORM_PASSWORD = "Your-Very-Strong-Password"
```