Deploy System and CDN for Applications Based on Telegram Mini Apps

Summary

Development of this grant consists of the following set of steps:

Implementation of the server side of the application, which contains information regarding the projects that exist in the system. We will call it the Backend API.
Implementation of the Telegram bot, which is the entry point into the system. This bot will be used to register new projects.
Implementation of a CLI utility that will be used by developers to upload their application resources to the system.
Connecting developer projects to CDN.

Let's describe each of these tasks in a more detailed manner, describing a reward for each part separately.

Backend API

Backend API is the heart and brain of the whole system at the same time. This part of the project is responsible for the logic in this project.

The implementation of this module implies the following tasks:

Database schema development. PostgreSQL should be used as the DBMS
Writing the code of the server application itself using Node.js and Nest.js
Deployment of the server application

Reward: $1000

Telegram Bot

As mentioned earlier, the Telegram bot is the entry point for a developer into the system. With the help of the bot, the developer should be able to register his project, get a token to deploy his application, delete it, and so on.

It is enough to implement the following functionality:

Creating a project using a given name
Deleting a project
Obtaining a token for application deployment

Reward: $800

CLI Utility

The CLI utility serves as a tool that developers will use on a regular basis. It should be an npm package that allows you to perform the following actions:

Get information about the base path that a developer should use when building their application
Upload the application files to the project's CDN. As a result, a developer should receive URLs of uploaded files
Maintain different versions of the uploaded files, because a developer would probably want to switch between different versions of their projects

The utility may look like the following:

# Deploy files.
cli deploy --project wallet --token abc --tag staging --dir my-folder

# Get project information.
cli info --project wallet --token abc --tag staging

Reward: $700

CDN

In order not to realize our own CDN from scratch, we can use the services of such a proven service as Gcore. It provides the functionality needed to solve the tasks of the current grant.

Reward: $50

Context

At the moment, the Telegram Mini Apps platform is developing at a rapid speed. As time passes, the development community needs not only new development tools, but also tools that can improve the app user experience.

One of the most important attributes of a great web app user experience is the speed of app opening, which often depends on the location of the hosting server.

In this grant we want to provide developers with a great alternative, a tool, to frequently used tools like GitHub Pages, Vercel and many others.

References

Here are the most famous alternatives for what we want to craft in this grant:

Estimate suggested reward

Summing everything up - $2550

I am sorry I forgot to leave a message here.

As of now, the project is almost ready, with all components implemented.

In the following sections, I will describe what has been completed.

Backend

[x] Method to retrieve project deployment information, used to get the base URL for static assets.
[x] Method to deploy project static assets. These assets will be uploaded to S3 storage and then served via the Gcore CDN.
[x] Functionality allowing developers to use different versions of their deployments through tags, enabling separate versions for environments like staging and master, for example.
[x] Authorization using a deploy key tied to the project.
[x] A set of methods for the Telegram Bot, allowing it to manage users' projects.
[x] A PostgreSQL database storing all users' data.

Telegram Bot

[x] Code based on grammy.
[x] Command /start - displays a welcome message and provides buttons for additional actions.
[x] Command /projects - shows a list of the user's current projects.
[x] Command /create - initiates the project creation process through a conversation flow.
[x] Pagination for the projects list.

All of the commands mentioned above utilize the Backend API functionality.

CLI

[x] Command to retrieve project deployment information.
[x] Command to deploy a specific directory to the CDN.
[x] Ability to use a configuration file.

I will add more information and links when the project is complete and can be reviewed.

ton-society / grants-and-bounties