generated from thebatclaudio/ton-dapp-vue-template
-
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
Showing
1 changed file
with
4 additions
and
88 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 |
|---|---|---|
| @@ -1,90 +1,6 @@ | ||
| # 🚀 TON DApp Vue Template | ||
| # x2 Lottery | ||
|
|
||
| Welcome to the **TON DApp Vue Template**! This project is a powerful template designed for creating a Telegram Mini App (TMA) with seamless integration of the TON blockchain using Vue.js. It comes fully equipped with Tailwind CSS for styling and includes a GitHub Actions workflow to automate deployment to GitHub Pages. | ||
| With love on ton-blockchain. | ||
|
|
||
| Demo: [https://thebatclaudio.github.io/ton-dapp-vue-template](https://thebatclaudio.github.io/ton-dapp-vue-template) | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
| ## 🌟 Features | ||
|
|
||
| - **Vue.js**: Build reactive and powerful UIs with the Vue.js framework. | ||
| - **TON Integration**: Easily connect and interact with the TON blockchain. | ||
| - **Telegram Mini App**: Create and deploy your application as a Telegram Mini App. | ||
| - **Tailwind CSS**: Utility-first CSS framework for rapidly building custom designs. | ||
| - **GitHub Pages Deployment**: Automatically deploy your app with GitHub Actions. | ||
|
|
||
| Explore these resources to extend and deepen your integration with TON and Telegram. | ||
|
|
||
| ## 🛠️ Getting Started | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| - **Node.js**: Ensure you have Node.js version 20 or higher installed. | ||
| - **NVM (Node Version Manager) (optional)**: Recommended for managing Node.js versions. If you don't use NVM, ensure you manually switch to Node.js version 20 or higher. | ||
|
|
||
| ### Installation | ||
|
|
||
| 1. **Clone the repository**: | ||
| ```bash | ||
| git clone https://github.com/thebatclaudio/ton-dapp-vue-template.git | ||
| cd ton-dapp-vue-template | ||
| ``` | ||
|
|
||
| 2. **Set the Node.js version** (if using NVM): | ||
| ```bash | ||
| nvm use | ||
| ``` | ||
|
|
||
| 3. **Install dependencies**: | ||
| ```bash | ||
| npm install | ||
| ``` | ||
|
|
||
| 4. **Set up environment variables**: | ||
| ```bash | ||
| cp .env.example .env | ||
| ``` | ||
|
|
||
| 5. **Edit the `.env` file**: | ||
| - Open the `.env` file and replace the placeholder values with your actual environment variables. | ||
|
|
||
| 6. **Run the development server**: | ||
| ```bash | ||
| npm run dev | ||
| ``` | ||
|
|
||
| ### 🌍 Deployment | ||
|
|
||
| This project includes a GitHub Actions workflow that automates deployment to GitHub Pages. To deploy your project: | ||
|
|
||
| 1. **Activate GitHub Pages**: | ||
| - Go to your GitHub repository settings. | ||
| - Under the **Pages** section, select the `GitHub Actions` branch as the source for build and deployment and save the settings. | ||
|
|
||
| 2. **Configure production environment variables**: | ||
| - Edit the `.env.production` file with the necessary environment variables for your production setup. | ||
|
|
||
| 3. **Push to the `main` branch**: | ||
| - The GitHub Actions workflow triggers on every push to `main` and will deploy the app to GitHub Pages automatically. | ||
|
|
||
| ## 📚 Documentation & References | ||
|
|
||
| This project leverages several powerful libraries and SDKs: | ||
|
|
||
| - **Telegram SDK**: [@telegram-apps/sdk](https://github.com/Telegram-Web-Apps/twa-dev-sdk) | ||
| - **TON SDK**: [@ton/ton](https://github.com/ton-blockchain/ton) | ||
| - **TON Connect UI**: [@tonconnect/ui](https://ton.org/docs/tonconnect/ui/) | ||
| - **Telegram Web App SDK**: [@twa-dev/sdk](https://github.com/Telegram-Web-Apps/twa-dev-sdk) | ||
|
|
||
| ## 🤝 Contributing | ||
|
|
||
| Contributions are welcome! Feel free to fork the project, submit a pull request, or open an issue for any changes or improvements. | ||
|
|
||
| ## 📄 License | ||
|
|
||
| This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information. | ||
| Play: https://t.me/x2lotterybot/play | ||
| Smart-contract: https://tonviewer.com/EQCnuaUFX1fxduNk5QvUMlexRmwHM08jfO5_zpQpkXjeWbL7 |