-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit fac37eb
Showing
43 changed files
with
11,150 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
module.exports = { | ||
env: { | ||
browser: true, | ||
es2021: true | ||
}, | ||
extends: [ | ||
'eslint:recommended', | ||
'plugin:@typescript-eslint/recommended', | ||
'plugin:react/recommended' | ||
], | ||
overrides: [ | ||
{ | ||
env: { | ||
node: true | ||
}, | ||
files: [ | ||
'.eslintrc.{js,cjs}' | ||
], | ||
parserOptions: { | ||
'sourceType': 'script' | ||
} | ||
} | ||
], | ||
parser: '@typescript-eslint/parser', | ||
parserOptions: { | ||
ecmaVersion: 'latest', | ||
sourceType: 'module' | ||
}, | ||
plugins: [ | ||
'@typescript-eslint', | ||
'react' | ||
], | ||
rules: { | ||
'react/react-in-jsx-scope': 0, | ||
} | ||
}; |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
# Simple workflow for deploying static content to GitHub Pages | ||
name: Deploy static content to Pages | ||
|
||
on: | ||
# Runs on pushes targeting the default branch | ||
push: | ||
branches: ['master'] | ||
|
||
# Allows you to run this workflow manually from the Actions tab | ||
workflow_dispatch: | ||
|
||
# Sets the GITHUB_TOKEN permissions to allow deployment to GitHub Pages | ||
permissions: | ||
contents: read | ||
pages: write | ||
id-token: write | ||
|
||
# Allow one concurrent deployment | ||
concurrency: | ||
group: 'pages' | ||
cancel-in-progress: true | ||
|
||
jobs: | ||
# Single deploy job since we're just deploying | ||
deploy: | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
|
||
- name: Setup node | ||
uses: actions/setup-node@v3 | ||
with: | ||
node-version: 18 | ||
registry-url: 'https://registry.npmjs.org' | ||
|
||
- name: Install pnpm | ||
uses: pnpm/action-setup@v2 | ||
id: pnpm-install | ||
with: | ||
version: 9.1.0 | ||
run_install: true | ||
|
||
- name: Build | ||
run: pnpm run build | ||
|
||
- name: Setup Pages | ||
uses: actions/configure-pages@v3 | ||
|
||
- name: Upload artifact | ||
uses: actions/upload-pages-artifact@v2 | ||
with: | ||
# Upload dist repository | ||
path: './dist' | ||
|
||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Logs | ||
logs | ||
*.log | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
pnpm-debug.log* | ||
lerna-debug.log* | ||
|
||
node_modules | ||
dist | ||
dist-ssr | ||
*.local | ||
|
||
# Editor directories and files | ||
.vscode/* | ||
!.vscode/extensions.json | ||
.idea | ||
.DS_Store | ||
*.suo | ||
*.ntvs* | ||
*.njsproj | ||
*.sln | ||
*.sw? | ||
|
||
*.pem |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,178 @@ | ||
# Telegram Mini Apps React Boilerplate | ||
|
||
This boilerplate demonstrates how developers can implement a single-page application on the Telegram | ||
Mini Apps platform using the following technologies and libraries: | ||
|
||
- [React](https://react.dev/) | ||
- [TypeScript](https://www.typescriptlang.org/) | ||
- [TON Connect](https://docs.ton.org/develop/dapps/ton-connect/overview) | ||
- [@tma.js SDK](https://docs.telegram-mini-apps.com/packages/tma-js-sdk) | ||
- [Telegram UI](https://github.com/Telegram-Mini-Apps/TelegramUI) | ||
- [Vite](https://vitejs.dev/) | ||
|
||
> This boilerplate was created using [npm](https://www.npmjs.com/). Therefore, it is required to use | ||
> it for this project as well. Using other package managers, you will receive a corresponding error. | ||
## Install Dependencies | ||
|
||
If you have just cloned this template, you should install the project dependencies using the | ||
command: | ||
|
||
```Bash | ||
npm install | ||
``` | ||
|
||
## Scripts | ||
|
||
This project contains the following scripts: | ||
|
||
- `dev`. Runs the application in development mode. | ||
- `build`. Builds the application for production. | ||
- `lint`. Runs [eslint](https://eslint.org/) to ensure the code quality meets the required | ||
standards. | ||
- `deploy`. Deploys the application to GitHub Pages. | ||
|
||
To run a script, use the `npm run` command: | ||
|
||
```Bash | ||
npm run {script} | ||
# Example: npm run build | ||
``` | ||
|
||
## Create Bot and Mini App | ||
|
||
Before you start, make sure you have already created a Telegram Bot. Here is | ||
the [comprehensive guide](https://docs.telegram-mini-apps.com/platform/creating-new-app) on how to | ||
do it. | ||
|
||
## Run | ||
|
||
Despite the fact that Mini Apps are intended to be opened | ||
inside [Telegram applications](https://docs.telegram-mini-apps.com/platform/about#supported-applications), | ||
you can still develop them outside of Telegram during the development process. Nevertheless, opening | ||
them inside Telegram will provide the most accurate expectation of how they will function in the | ||
real world. | ||
|
||
Once the application is created successfully, run it using the `dev` script: | ||
|
||
```bash | ||
npm run dev | ||
``` | ||
|
||
After this, you will see a similar message in your terminal: | ||
|
||
```bash | ||
VITE ready in 275 ms | ||
|
||
➜ Local: https://localhost:5173/reactjs-template | ||
➜ Network: https://192.168.0.1:5173/reactjs-template | ||
➜ press h + enter to show help | ||
``` | ||
|
||
To open the application, you need to copy the `Network` | ||
link (`https://192.168.0.1:5173/reactjs-template` in this example) and choose one of the following: | ||
|
||
1. Open it directly in your browser and start developing. Note that in this case, you will be | ||
slightly restricted in allowed functionality and may see some behavior different from the | ||
Telegram application. | ||
2. Submit it as the Mini App link to @BotFather. Then go to https://web.telegram.org/k/, find your | ||
bot, and launch the Telegram Mini App. This way, you will get the full development experience. | ||
|
||
## Deploy | ||
|
||
This boilerplate uses GitHub Pages as the way to host the application externally. GitHub Pages | ||
provides a CDN which will let your users receive the application rapidly. Alternatively, you could | ||
use such services as [Heroku](https://www.heroku.com/) or [Vercel](https://vercel.com). | ||
|
||
### Manual Deployment | ||
|
||
This boilerplate uses the [gh-pages](https://www.npmjs.com/package/gh-pages) tool, which allows | ||
deploying your application right from your PC. | ||
|
||
#### Configuring | ||
|
||
Before running the deployment process, ensure that you have done the following: | ||
|
||
1. Replaced the `homepage` value in `package.json`. The GitHub Pages deploy tool uses this value to | ||
determine the related GitHub project. | ||
2. Replaced the `base` value in `vite.config.ts` and have set it to the name of your GitHub | ||
repository. Vite will use this value when creating paths to static assets. | ||
|
||
For instance, if your GitHub username is `telegram-mini-apps` and the repository name | ||
is `is-awesome`, the value in the `homepage` field should be the following: | ||
|
||
```json | ||
{ | ||
"homepage": "https://telegram-mini-apps.github.io/is-awesome" | ||
} | ||
``` | ||
|
||
And `vite.config.ts` should have this content: | ||
|
||
```ts | ||
export default defineConfig({ | ||
base: '/is-awesome/', | ||
// ... | ||
}); | ||
``` | ||
|
||
You can find more information on configuring the deployment in the `gh-pages` | ||
[docs](https://github.com/tschaub/gh-pages?tab=readme-ov-file#github-pages-project-sites). | ||
|
||
#### Before Deploying | ||
|
||
Before deploying the application, make sure that you've built it and going to deploy the fresh | ||
static files: | ||
|
||
```bash | ||
npm run build | ||
``` | ||
|
||
Then, run the deployment process, using the `deploy` script: | ||
|
||
```Bash | ||
npm run deploy | ||
``` | ||
|
||
After the deployment completed successfully, visit the page with data according to your | ||
username and repository name. Here is the page link example using the data mentioned above: | ||
https://telegram-mini-apps.github.io/is-awesome | ||
|
||
### GitHub Workflow | ||
|
||
To simplify the process of deployment, this boilerplate contains already | ||
written [GitHub workflow](.github/workflows/github-pages-deploy.yml) to deploy the project | ||
automatically in case, some content was pushed to the `master` branch. | ||
|
||
To let this workflow work properly, it is required create a new environment (or edit the existing | ||
one) in the GitHub repository Settings with the name `github-pages`. Then, add the `master` branch | ||
to the list of deployment branches. | ||
|
||
Environments settings could be find using this | ||
URL: `https://github.com/{username}/{repository}/settings/environments` | ||
|
||
![img.png](.github/deployment-branches.png) | ||
|
||
In case, you don't want to do it automatically, or you don't use GitHub as the project codebase, | ||
just remove the `.github` directory. | ||
|
||
### GitHub Web Interface | ||
|
||
Alternatively, developers are able to configure the automatic deployment using GitHub web interface. | ||
To use it, follow the link: `https://github.com/{username}/{repository}/settings/pages`. | ||
|
||
## TON Connect | ||
|
||
This boilerplate uses the [TON Connect](https://docs.ton.org/develop/dapps/ton-connect/overview) | ||
project to showcase how developers could integrate TON cryptocurrency-related functionality. | ||
|
||
The TON Connect manifest used in this boilerplate is located in the `public` folder along with all | ||
publicly available static files. Don't forget | ||
to [configure](https://docs.ton.org/develop/dapps/ton-connect/manifest) this file according to your | ||
project information. | ||
|
||
## Useful Links | ||
|
||
- [Platform documentation](https://docs.telegram-mini-apps.com/) | ||
- [@tma.js/sdk-react documentation](https://docs.telegram-mini-apps.com/packages/tma-js-sdk-react) | ||
- [Telegram developers community chat](https://t.me/devs) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
// helloworlds |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
<!doctype html> | ||
<html lang="en"> | ||
<head> | ||
<meta http-equiv="Cache-Control" content="no-cache, no-store, must-revalidate" /> | ||
<meta http-equiv="Pragma" content="no-cache" /> | ||
<meta http-equiv="Expires" content="0" /> | ||
<meta charset="utf-8"/> | ||
<meta name="viewport" content="width=device-width, initial-scale=1"/> | ||
<meta name="theme-color" content="#000000"/> | ||
<title>Telegram Mini App</title> | ||
<link rel="preconnect" href="https://fonts.googleapis.com"> | ||
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin> | ||
<link | ||
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,300;0,400;0,500;0,700;0,900;1,100;1,300;1,400;1,500;1,700;1,900&display=swap" | ||
rel="stylesheet" | ||
> | ||
</head> | ||
<body> | ||
<noscript>You need to enable JavaScript to run this app.</noscript> | ||
<div id="root"></div> | ||
<script src="/src/index.tsx" type="module"></script> | ||
</body> | ||
</html> |
Oops, something went wrong.