https://github.com/jqwidgets/create-jqwidgets-react-tsx-app
https://github.com/jqwidgets/create-jqwidgets-react-tsx-app
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/jqwidgets/create-jqwidgets-react-tsx-app
- Owner: jqwidgets
- Created: 2019-02-15T12:13:12.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T21:49:40.000Z (over 3 years ago)
- Last Synced: 2024-10-04T19:06:39.392Z (over 1 year ago)
- Language: TypeScript
- Size: 3.51 MB
- Stars: 7
- Watchers: 2
- Forks: 2
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# create-jqwidgets-react-tsx-app
Please refer to its documentation:
- [Getting Started](https://github.com/jqwidgets/create-jqwidgets-react-tsx-app/blob/master/README.md#getting-started)
- [jQWidgets React TSX Documentation](http://www.jqwidgets.com/reactjs-components-documentation/)
This project is based on [create-react-app](https://github.com/facebookincubator/create-react-app).
## Quick Overview
```sh
npm i -g create-jqwidgets-react-tsx-app
create-jqwidgets-react-tsx-app my-app
cd my-app
npm start
```
When you’re ready to deploy to production, create a minified bundle with `npm run build`.
## Getting Started
### Installation
Install it once globally:
```sh
npm install -g create-jqwidgets-react-tsx-app
```
**Make sure you have the latest version of [Node](https://nodejs.org/en/) on your machine**.
### Creating an App
```sh
create-jqwidgets-react-tsx-app my-app
cd my-app
```
It will create a directory called `my-app` inside the current folder.
Inside that directory, it will generate the initial project structure and install the transitive dependencies:
```
my-app
├── node_modules
├── public
├── src
├── .gitignore
├── package.json
├── package-lock.json
├── README.md
├── tsconfig.json
├── yarn.lock
```
Subfolders are not shown in order to keep it short.
Once the installation is done, you can run some commands inside the project folder:
### `npm start`
Builds the app in development mode and starts a web server.
The page will reload if you make edits.
### `npm run build`
Builds the app in production mode and stores it in the `build/` directory.
It correctly bundles React in production mode and optimizes the build for the best performance.
By default, it also includes a service worker so that your app loads from local cache on future visits.
## Why Use This?
**If you’re getting started** with `jQWidgets` and `React`, using `create-jqwidgets-react-tsx-app` is the easiest way to do this.
Just install, run and you will see an React jQWidgets Grid on your page.
Then you can customize the project as much as you want, making something great.
