Certainly! Here's a README.md
file for the Stickerator project:
# Stickerator
Stickerator is a web application that allows you to create Telegram sticker packs easily. Upload your images, process them, and publish them directly to Telegram as a sticker pack.
## Features
- Upload images to create stickers.
- Remove background from images.
- Resize and compress images for optimal sticker size.
- Publish stickers directly to Telegram.
- Save Telegram API token and sticker pack name in cookies for convenience.
## Getting Started
### Prerequisites
- Node.js (version 14 or later)
- NPM or Yarn
### Installation
1. Clone the repository:
```sh
git clone https://github.com/Stickerator/stickerator.github.io.git
cd stickerator.github.io
- Install dependencies:
npm install
# or
yarn install
- Start the development server:
npm start
# or
yarn start
- Open your browser and navigate to
http://localhost:3000
.
To create a production build of the application, run:
npm run build
# or
yarn build
The production build will be available in the build
directory.
-
Upload Images: Click on the "Select Input Type" dropdown and choose "File Upload". Upload the images you want to use for your sticker pack.
-
Provide Telegram API Token: Enter your Telegram API token. You can get the API token for free from BotFather. Create a bot and send at least one message to it.
-
Enter Sticker Pack Name: Enter a name for your sticker pack. The name must end with
_by_<botname>
. -
Generate Stickers: Click the "Generate" button to start the process. The status of the process will be displayed, and a progress bar will indicate the progress.
-
Add Sticker Pack to Telegram: Once the sticker pack is created successfully, a link will be provided. Click the link to add the sticker pack to your Telegram.
Contributions are welcome! Please feel free to submit a Pull Request.
This project is licensed under the MIT License - see the LICENSE file for details.
If you have any questions or feedback, please feel free to contact us.
Happy Stickering!