xavierxross / 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!

Telecord bot

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

View Demo · Report Bug · Request Feature

Table of Contents

• Table of Contents
• About The Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
  • Running the project
• Usage (TODO)
• 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

Running the project

Running the project is very simple.

yarn start

Usage

t.register https://telegram.me/yourusernamehere (registers you in the bot's database)
t.profile (with no arguements returns your profile)
t.profile @johndoe#0000 (pulls up another user's profile)
t.edit https://telegram.me/yournewusernamehere
t.delete (removes your account from the database)
t.help (sends the help message)
t.source (sends a link to the github page)
t.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 😄.

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.