Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
BahmanTimas committed Oct 10, 2023
1 parent 6685eee commit 4c12c35
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Mini Woo is a project that allows you to create a [mini app](https://core.telegram.org/bots/webapps) for [Telegram](https://telegram.org/), the messaging app with over 500 million active users, that connects to your [WooCommerce](https://woocommerce.com/) website, the most popular e-commerce platform on the web. It uses [Next.js](https://nextjs.org/), a React framework for building fast and scalable web applications, and the Telegram [Bot API](https://core.telegram.org/bots/api) and the WooCommerce [REST API](https://woocommerce.github.io/woocommerce-rest-api-docs/) to provide a seamless shopping experience for your customers on Telegram.

You can use this project as a template to customize your mini app with your own branding, products, and features, or modify the API to connect any other online store that supports RESTful web services. This project is open source and free to use. You can find the source code, documentation, and installation instructions here on GitHub.
You can use this project as a template to customize your mini app with your own branding, products, and features, or modify the API to connect any other online store that supports RESTful web services. This project is open source and free to use. You can find the source code, documentation, and installation instructions [here on GitHub](https://github.com/mini-woo/mini-woo).

## Requirements

Expand All @@ -13,6 +13,12 @@ You can use this project as a template to customize your mini app with your own

## Getting Started

1. Prepare Environment Variables
2. Deploy
3. Init Telegram Bot API Webhook

### Environment Variables

To use this project, you need to set the following environment variables:

- `NEXT_PUBLIC_BASE_PATH`
Expand All @@ -39,6 +45,7 @@ You need to deploy your app on a platform or a server of your choice.
#### Deploy on Vercel

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
You need to fork this repository first.

Check out [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.

Expand Down

0 comments on commit 4c12c35

Please sign in to comment.