Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shiyinq/anonim-chat

🎭 Anonymously chat with a stranger.
https://github.com/shiyinq/anonim-chat

anon-chat anonim-chat anonymous-chat bot telegram-bot

Last synced: about 9 hours ago
JSON representation

🎭 Anonymously chat with a stranger.

Awesome Lists containing this project

README

        

# anonim-chat
[![GitHub top language](https://img.shields.io/github/languages/top/Shiyinq/anonim-chat)](https://github.com/Shiyinq/anonim-chat)
![GitHub repo size](https://img.shields.io/github/repo-size/Shiyinq/anonim-chat)
![GitHub last commit](https://img.shields.io/github/last-commit/Shiyinq/anonim-chat)
![GitHub commit activity](https://img.shields.io/github/commit-activity/w/Shiyinq/anonim-chat)

| ![anonim-chat-1](docs/images/anonim-chat-1.png) | ![anonim-chat-2](docs/images/anonim-chat-2.png) | ![anonim-chat-3](docs/images/anonim-chat-3.png) |
|:---:|:---:|:---:|

Anonymously chat with a stranger.

## Table of Contents
- [anonim-chat](#anonim-chat)
- [Table of Contents](#table-of-contents)
- [Requirements](#requirements)
- [Development](#development)
- [Deployment](#deployment)

## Requirements
- Node JS v20.10.0
- NPM v10.2.3
- nodemon lates
- MongoDB v5

## Development
Clone and install dependencies.

**1. Clone this repository**
```
git clone https://github.com/Shiyinq/anonim-chat.git
```
**2. Navigate to the project directory**

```bash
cd anonim-chat
```
**3. Install dependencies**

```bash
npm install
```

**4. Create `.env` file**

```base
cp .env.example .env
```

**5. Fill the `BOT_TOKEN`**

you can get token from [@BotFather](https://t.me/botfather)

**6. Run the bot script**

```bash
npm run dev
```

**7. Test your bot**
- Open Telegram and find the bot you created with @BotFather.
- Start a conversation with your bot to ensure it's responding correctly.
- For a more comprehensive test:
- Use two different Telegram accounts.
- Simulate a conversation between a user and your bot.

## Deployment
Before you begin, ensure you have [Docker](https://docs.docker.com/engine/install/) installed.

**1. Clone the repository**
```bash
git clone https://github.com/Shiyinq/anonim-chat.git
cd anonim-chat
```

**2. Create environment files**
```bash
cp .env.example .env
```

Open `.env` file you have created and update the values.

**3. Build and run the Docker containers**
```bash
docker compose up --build -d
```
Wait a few minutes for the setup to complete, bot running on http://localhost:8080.