Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/itwin/course_1-smart-house-sample
Smart house app for the Associate level iTwin Developer Accreditation Course
https://github.com/itwin/course_1-smart-house-sample
accreditation education itwin-platform
Last synced: 3 months ago
JSON representation
Smart house app for the Associate level iTwin Developer Accreditation Course
- Host: GitHub
- URL: https://github.com/itwin/course_1-smart-house-sample
- Owner: iTwin
- License: mit
- Created: 2021-04-14T23:02:56.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-10-03T17:52:54.000Z (over 1 year ago)
- Last Synced: 2024-04-15T06:45:28.020Z (10 months ago)
- Topics: accreditation, education, itwin-platform
- Language: TypeScript
- Homepage:
- Size: 28.5 MB
- Stars: 5
- Watchers: 4
- Forks: 15
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Getting Started with the iTwin Viewer Create React App Template
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
## Environment Variables
Prior to running the app, you will need to add OIDC client configuration to the variables in the .env file:
```
# ---- Authorization Client Settings ----
IMJS_AUTH_CLIENT_CLIENT_ID=""
IMJS_AUTH_CLIENT_REDIRECT_URI=""
IMJS_AUTH_CLIENT_LOGOUT_URI=""
IMJS_AUTH_CLIENT_SCOPES =""
```
- You can generate a [test client](https://developer.bentley.com/tutorials/web-application-quick-start/#2-register-an-application) to get started.
- When you are ready to build a production application, [register here](https://developer.bentley.com/register/).
You should also add a valid iTwinId and iModelId for your user in the this file:
```
# ---- Test ids ----
IMJS_ITWIN_ID = ""
IMJS_IMODEL_ID = ""
```
- For the IMJS_ITWIN_ID variable, you can use the id of one of your existing Projects or Assets. You can obtain their ids via the [Administration REST APIs](https://developer.bentley.com/api-groups/administration/api-reference/).
- For the IMJS_IMODEL_ID variable, use the id of an iModel that belongs to the iTwin that you specified in the IMJS_ITWIN_ID variable. You can obtain iModel ids via the [Data Management REST APIs](https://developer.bentley.com/api-groups/data-management/apis/imodels/operations/get-project-or-asset-imodels/).
- Alternatively, you can [generate a test iModel](https://developer.bentley.com/tutorials/web-application-quick-start/#3-create-an-imodel) to get started without an existing iModel.
- If at any time you wish to change the iModel that you are viewing, you can change the values of the iTwinId or iModelId query parameters in the url (i.e. localhost:3000?iTwinId=myNewITwinId&iModelId=myNewIModelId)
## Available Scripts
In the project directory, you can run:
### `npm start`
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will reload if you make edits.\
You will also see any lint errors in the console.
### `npm test`
Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
### `npm run build`
Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### `npm run eject`
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
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.
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.
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.
## Next Steps
- [iTwin Viewer options](https://www.npmjs.com/package/@itwin/web-viewer-react)
- [Extending the iTwin Viewer](https://www.itwinjs.org/learning/tutorials/hello-world-viewer/)
- [Using the iTwin Platform](https://developer.bentley.com/)
- [iTwin Developer Program](https://www.youtube.com/playlist?list=PL6YCKeNfXXd_dXq4u9vtSFfsP3OTVcL8N)