Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/twa-dev/webpack-boilerplate
Liberal Create React App for TWA enthusiasts
https://github.com/twa-dev/webpack-boilerplate
boilerplate-front-end react twa-dev
Last synced: 11 days ago
JSON representation
Liberal Create React App for TWA enthusiasts
- Host: GitHub
- URL: https://github.com/twa-dev/webpack-boilerplate
- Owner: twa-dev
- License: mit
- Created: 2022-09-11T12:03:11.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-09-18T09:20:33.000Z (about 1 year ago)
- Last Synced: 2024-05-19T03:23:02.705Z (6 months ago)
- Topics: boilerplate-front-end, react, twa-dev
- Language: JavaScript
- Homepage: https://boilerplate-twa-dev.vercel.app
- Size: 506 KB
- Stars: 31
- Watchers: 0
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ton - twa-dev/boilerplate - Another boilerplate for a new TWA. (🧑💻 Get Coding / Dev Tools)
README
# Boilerplate
If you want to start a new project and fully control your infrastructure, you can use our Boilerplate.
## Quick start
```bash
- git clone [email protected]:twa-dev/Boilerplate.git {projectName}
- cd {projectName}
- yarn install
- yarn start
```
## Documentation
This project solves all the famous problems you gonna face if you develop TWA.
### Development
`yarn start` starts dev server on 9000 port. It optionally includes ngrok proxy. Ngrok allows you instantly deploy the app
to the internet. It can be useful if you want to see how your application works inside Telegram.
### Build
`yarn build` creates an optimized production-ready bundle inside `dist` directory.
### Bundle analyze
`yarn analyze` shows you what your js-bundle consists of. Use this utility if you have performance issues.
### Static analyze
- `yarn test:eslint` and `yarn test:stylelint` runs linters;
- `yarn tsc` runs type check;
- `yarn prettier` runs prettier (it will check your formatting but won't change anything)
If you work in a team it's important to keep a consistent code style. Include these commands in your CI process to prevent code base inconsistency.
## Technologies
Boilerplate uses Webpack, CSS Modules, TypeScript, React, [@twa-dev/sdk](https://github.com/twa-dev/sdk), [@twa-dev/mark42](https://github.com/twa-dev/Mark42), eslint, stylelint, prettier and ngrok.
All these tools help you to deliver your features fast and confidently.
### SVG
There are two different ways to import SVG: as a component and as an asset. If you want to use SVG as a component,
you have to add "component." before an extension. Example:
```tsx
import diamond from "./diamond.svg";
import Diamond from "./diamond.component.svg";
```
### CSS Modules
All `*.module.css` files are treated as isolated [CSS Modules](https://github.com/css-modules/css-modules). It means that you don't have to worry about class name collisions.
Moreover, this CSS is typed, so it's impossible to use unexisting class names in `.tsx`. Boilerplate uses named exports for CSS to improve TS checks.
### Ngrok
[Ngrok](https://ngrok.com/) is a powerful tool for creating tunnel between your computer and the internet. It's
already built in `yarn start` command. To enable Ngrok you need to create `ngrok.json` in the root of your project.
**Important:** you have to buy Ngrok subscription if you want to register fixed subdomain names.
Example of `ngrok.json`:
```json
{
"authtoken": "abcd",
"subdomain": "{subdomain}",
"region": "{region}"
}
```
Now if you run `yarn start`, your local version of TWA will be available on _https://{subdomain}.{region}.ngrok.io/_. That's it. All you need to do is to [set](https://core.telegram.org/bots/webapps#launching-web-apps-from-the-menu-button) this URL as Menu Button URL.