https://github.com/telexintegrations/telex-wordle
https://github.com/telexintegrations/telex-wordle
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/telexintegrations/telex-wordle
- Owner: telexintegrations
- Created: 2025-02-23T08:29:12.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-24T10:00:05.000Z (over 1 year ago)
- Last Synced: 2025-02-24T11:21:32.864Z (over 1 year ago)
- Language: JavaScript
- Size: 8.25 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Telex Wordle
This is a Node.js/Express application that integrates with Telex. Telex Wordle provides the wordle of the day on user's request.
## Prerequisites
- Node.js
- npm (Node Package Manager)
## Installation
1. Fork the repository.
2. Clone the repository.
```bash
git clone https://github.com/your_username/telex_wordle.git
```
3. Install dependencies:
```bash
npm install
```
## Running the Application
To run the application:
```bash
node index.js
```
The server will start on the port specified.
## API Endpoints
### POST /webhook
Receives messages from Telex channels. The endpoint expects a JSON payload with the following structure:
```json
{
"channel_id": "string",
"settings": [
{
"label": "Provide Answer",
"type": "text",
"required": true,
"default": "No"
}
],
"message": "string"
}
```
User's input is contained in "message". If the user sends a random text, they would get a reply saying 'To see the wordle of the day, enter 'wordle' in the chat box'.
If they input 'wordle', they would receive a response saying 'The wordle of the day is: word'
#### Process
A request is made to the Wordle API hitting the API's endpoint /answer and the word is extracted from the response, then sent back to telex
```json
{
"status": "success",
"message": "The wordle of the day is: ${word}"
}
```
or
```json
{
"status": "success",
"message": "To see the wordle of the day, enter 'wordle' in the chat box"
}
```
Depending on user input.
### GET /integration
Returns the integration configuration for Telex. Use this configuration to set up your integration in the Telex dashboard.
## Features
- **Integration with Wordle API:** Gets wordle of the day from https://wordle-api-kappa.vercel.app
- **CORS Support:** Allows cross-origin requests to ease integration.
## Testing
+ Tested the integration on Telex App
+ Wrote unit tests
## Deployment
The Integration was deployed on Vercel and Telex