cra-template-itwinjsstarter
v1.0.2
Published
The base template to start with iTwinJs.
Downloads
16
Maintainers
Readme
iModel.js Starter
An iModel.js sample application that demonstrates:
- Getting Authorization
- Openning iModel
- Creating an rpc interface
- Communicating with backend and returning data.
This app serves as a guide on how one can start using iModel.js and get the basics done which leads them to start implementing their own components.
See http://imodeljs.org for comprehensive documentation on the iModel.js API and the various constructs used in this sample.
Prerequisites
- Git
- Node: an installation of the latest security patch of Node 10 or 12. The Node installation also includes the npm package manager.
- TypeScript: this is listed as a devDependency, so if you're building it from source, you will get it with
npm install
. - Visual Studio Code: an optional dependency, but the repository structure is optimized for its use
See supported platforms for further information.
Development Setup
Ignore any issues during creation of project using template, they are usually because of version mismatch and are fixed at step 4.
Register a sample project at (https://www.connect-bentley.com) and create a iModel within it.
Edit the
.env.local
file with your created project name and iModel name.Run the command
npm install
to install all the dependencies.Run the command
npm run build
to build the app.Run the command
npm run start
to start both the backend and frontend.Happy Coding :)