Skip to content

Commit

Permalink
@StickernizerBot - a Mini App example of video editor. In @Stickerniz…
Browse files Browse the repository at this point in the history
…erBot users can make video stickers right in telegram, app provides workspace where you can build your stickers and page where you can load your saved sticker. @StickernizerBot sends you created stickers in target format to send them to the https://t.me/Stickers
  • Loading branch information
fede4ka1245 committed Oct 10, 2023
1 parent 6b83501 commit a4863ad
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions frontend/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
## Backend documentation
### Run in dev mode
* Make .env file with these vars:
```
REACT_APP_API_URL= //url where your bot (backend) is located
REACT_APP_ABOUT_LINK= //Optional. The link with article (or smth) where you describe your bot.
```
* Run commands:
```
npm i
npm run start
```

### Architecture
* **/ui** - bricks components to build app
* **/components** - components build from ui but doesnt have business logic
* **/modules** - components that have zone of own zone responsibility and own business logic
* **/pages** - components where modules grouped
* **/shared and /hooks** - logic to work with other global
pieces (currently store stickers in Cloud Storage)

## Modules
**Saved stickers** - place where user can get their saved sticker

**App feedback** - async functions which emit custom prompt, confirm, alert

**Sticker Editor** - Main logic of app. The place where users build their stickers

1 comment on commit a4863ad

@fede4ka1245
Copy link
Owner Author

@fede4ka1245 fede4ka1245 commented on a4863ad Oct 16, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a mistake inside of a docker-compose.yml: frontend service doesnt get any env vars.

Just set .env file with frontend's vars to /frontend dir

Please sign in to comment.