Production Deploy on Telegram: @HarmonyLotteryBot
- Framework: React
- Deployment: Netlify (Automatic deployment from
miniApp
branch) - Video Player: User's viewing status is consistently tracked down every fraction of a second to ensure the user has indeed watched the video until the end to reward NIL points. Users must watch threshold (90%) of video duration to claim reward. If video is skipped (>3 seconds), watch time counter is halted.
- Framework: Express, Node.js, Axios
- Deployment: Heroku (Manual deployment with
git push heroku master
) - Components: Includes both bot server and API server in
index.js
-
GET /points
- Parameters:
userId
- Description: Retrieves the user's NIL balance (points).
- Parameters:
-
GET /watch
- Parameters:
userId
,videoId
- Description: Calls the function to mark a video as watched.
- Parameters:
-
GET /watchedVideos
- Parameters:
userId
- Description: Retrieves the list of videos the user has watched.
- Parameters:
-
POST /updateWatchedVideos
- Parameters:
userId
,videoId
- Description: Updates the user's watched videos list.
- Parameters:
-
GET /youtube/viewcount
- Parameters:
url
- Description: Fetches view count of specific youtube video from url
- Parameters:
- Integration: Telegram MiniApp
- Database: Port user database from
index.js
server to an actual database. - Video Player: Implement a video player to embed YouTube videos when clicked on "watch" button.
- Verify watching video: Implement a way to confirm the user has watched the video until the end, no skipping or just clicking on url.
- Fix fastfowarding increasing watch time issue
- UI Update: Enhance the web UI for better visuals.--TBD
- Video List Management: Clean up and streamline the video list to allow updates from a single file.
- TMA UI Improvement: Enhance the Telegram Mini App UI with features such as back buttons and better navigation.
- Update bot details (change bot username)
- Add inline keyboard menu button 'play'
- Integrate Youtube API
Previous testing stuff are stored on other branches (chat-based inetraction, lottery, etc)
- Install dependencies for both client and server:
npm i
- Telegram: Create your bot with Telegram BotFather. Get API key,
touch .env
in/server
(example given in .env.example). - Server-side: Dpeloy to server-hosting or on local:
cd server
node index.js
- Modify client-side API endpoint URLs in
client/App.js
with your PORT or deployed server URL. - Client-side: Deploy client side on hosting app. Make sure to add deploy setting
npm run build
. (Will need to be on hosting app, not local since need to connect through Telegram). - Give command to BotFather
/newapp
and register your Web App URL (front-end deploy link). - (Optional) Give command to BotFather
/setmenubutton
to add menu button to bot.