Skip to content

Latest commit

 

History

History
64 lines (41 loc) · 2.06 KB

README.md

File metadata and controls

64 lines (41 loc) · 2.06 KB
Raw

Telegram Mini Apps Template

tma-nextjs-starter

Features

  • Next.js Framework: Benefit from the powerful features of Next.js, including server-side rendering and static site generation.
  • TonConnect UI Integration: Easily connect to the TonConnect ecosystem for seamless user authentication and interaction.
  • Telegram Mini Apps (TMA): Build and integrate Telegram Mini Apps with ease, leveraging the power of Telegram's ecosystem.

Getting Started

Prerequisites

  • Node.js (v14.x or later)
  • pnpm (recommended) or npm

Installation

  1. Clone the repository:

    git clone https://github.com/liect/tma-nextjs-starter
cd tma-nextjs-starter

  2. Install dependencies:

    # recommended
pnpm install

  3. Run the development server:

     # recommended
 pnpm run dev

Open your browser and navigate to http://localhost:3000 to see the application in action.

Usage

This template provides a basic structure for developing Telegram applications. You can customize the components and styles according to your needs. The template includes sample code for integrating TonConnect UI and TMA, which you can modify and expand upon.

Environment Variables

The template uses environment variables to store sensitive information and configuration settings. You can create a .env.local file in the root directory and add the following variables:

# TonConnect manifest URL 
NEXT_PUBLIC_MANIFEST_URL=YOUR_MANIFEST_URL

Contributing

We welcome contributions from the community! If you have any ideas, suggestions, or improvements, please feel free to submit a pull request or open an issue.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Feel free to customize this template further to match your specific project requirements and details.