Telecord

A discord bot to link your Discord Account and Telegram Account so you can easily start up encrypted chat messages with your discord friends!


· Report Bug · Request Feature

Table of Contents

• Table of Contents
• About The Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
  • Running the project
• Usage
• Roadmap
• Contributing
• License

About The Project

Built With

• node.js
• typescript
• yarn
• discord.js
• mongoose
• mongoDB

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

As this project uses yarn, make sure you have yarn installed by running yarn --version. It should show a verson < 2.X.X. This is because this project does not yet support yarn 2. If you don't have yarn installed, install it by running

npm i -g yarn@latest

Installation

1. Clone the repo

git clone https://github.com/GlenMerlin/Telecord.git

2. Install NPM packages

yarn

3. Set variables in config.json

cd pathToTelecord/src
cp config.example config.json

Simply set the proper values URI and Token for your database and discord bot respectively

Running the project

Running the project is very simple.

run

npx tsc

to compile the typescript into javascript

run

yarn dev

to start the bot

Usage

/register https://telegram.me/yourusernamehere (registers you in the bot's database)
/profile (with no arguements returns your profile)
/profile @johndoe#0000 (pulls up another user's profile)
/edit https://telegram.me/yournewusernamehere
/delete (removes your account from the database)
/help (sends the help message)
/source (sends a link to the github page)
/invite (sends an invite to add the bot to your own server)

Roadmap

See the pinned issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'feat: Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

You are requested to follow the contribution guidelines specified in CONTRIBUTING.md while contributing to the project 😄.

Privacy

What data we collect:

• Discord account IDs (snowflakes)
• Links you provide

This bot is open source partially because of the privacy aspect, this bot does not read conversations and only stores your userID in association with your telegram link

if you wish to delete your account and wipe all data the bot has collected simply run /delete, if for some reason you are unable to access your discord account and want your data deleted reach out to me at glenmerlin@glenmerlin.me

License

Distributed under the GNU GPLv3 License. See LICENSE for more information.

---

This readme file, along with the contributing and code of conduct files were originally made from this template made by CSIVitu.