|
1 | | -# Getting Started with Create React App |
| 1 | +# Getting Started with SQL Scratchpad |
2 | 2 |
|
3 | | -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). |
| 3 | +This projects demonstrates how you can use the Hue web components from within a React project to |
| 4 | +create a SQL Scratchpad. |
4 | 5 |
|
5 | | -## Available Scripts |
| 6 | +It's based on a clean create-react-app project, relevant changes are: |
6 | 7 |
|
7 | | -In the project directory, you can run: |
| 8 | +- gethue dependency in package.json, note that this can also be pulled in from the npm repo by specifing a version > 4.9) |
| 9 | +- "components" folder with React wrappers around the Hue web components |
| 10 | +- App.tsx using the React wrappers |
8 | 11 |
|
9 | | -### `npm start` |
| 12 | +We wrap the web components to be able to set certain attributes/properties on the web component elements that are required by the web components. |
10 | 13 |
|
11 | | -Runs the app in the development mode.\ |
12 | | -Open [http://localhost:3000](http://localhost:3000) to view it in the browser. |
| 14 | +## To run this project |
13 | 15 |
|
14 | | -The page will reload if you make edits.\ |
15 | | -You will also see any lint errors in the console. |
| 16 | +### In the Hue root folder: |
| 17 | +1. `npm install` |
| 18 | +2. `npm run webpack-npm` |
| 19 | + |
| 20 | +### In this project folder: |
| 21 | +3. `npm install` |
| 22 | +4. `npm start` |
| 23 | +5. Open [http://localhost:3000](http://localhost:3000) to view it in the browser. |
16 | 24 |
|
17 | | -### `npm test` |
| 25 | +## Base project creation steps (for reference) |
18 | 26 |
|
19 | | -Launches the test runner in the interactive watch mode.\ |
20 | | -See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. |
21 | | - |
22 | | -### `npm run build` |
23 | | - |
24 | | -Builds the app for production to the `build` folder.\ |
25 | | -It correctly bundles React in production mode and optimizes the build for the best performance. |
26 | | - |
27 | | -The build is minified and the filenames include the hashes.\ |
28 | | -Your app is ready to be deployed! |
29 | | - |
30 | | -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. |
31 | | - |
32 | | -### `npm run eject` |
33 | | - |
34 | | -**Note: this is a one-way operation. Once you `eject`, you can’t go back!** |
35 | | - |
36 | | -If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. |
37 | | - |
38 | | -Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. |
39 | | - |
40 | | -You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. |
41 | | - |
42 | | -## Learn More |
43 | | - |
44 | | -You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). |
45 | | - |
46 | | -To learn React, check out the [React documentation](https://reactjs.org/). |
| 27 | +1. `npx create-react-app sql-scratchpad --template typescript` |
| 28 | +2. add `"gethue": "file:../../../../npm_dist"` to dependencies in package.json |
| 29 | +3. add `SKIP_PREFLIGHT_CHECK=true` to .env (required when running inside nested Hue folder) |
0 commit comments