b8b33269e1 | ||
---|---|---|
.github | ||
.vscode | ||
docs/walkthrough | ||
public | ||
scripts | ||
src | ||
.env | ||
.eslintrc | ||
.flowconfig | ||
.gitattributes | ||
.gitignore | ||
CONTRIBUTING.md | ||
LICENSE | ||
README.md | ||
jsconfig.json | ||
package-lock.json | ||
package.json |
README.md
Azure Remote Monitoring WebUI
Web app for Azure IoT Remote Monitoring Solution dotnet and java.
Prerequisites
1. Deploy a Remote Monitoring Solution
The easiest way to test the Web UI is against a deployed remote monitoring solution. The solution can be deployed via the web interface or via the command line.
It is also possible to deploy the solution locally.
2. Setup Dependencies
- Install node.js
- For development, you can use your preferred editor
- Visual Studio Code
- Atom
- Sublime Text
- or other preferred editor
3. Environment variables required to run the Web UI
In order to run the Web UI, the following environment variables need to be created at least once. More information on configuring environment variables here.
REACT_APP_BASE_SERVICE_URL
= {your-remote-monitoring-endpoint}
The endpoint given above is the base url you navigate to in order to see your deployed solution.
The Web UI configuration is stored in app.config.js. You can edit this file to update the endpoints.
Build, run and test locally
cd ~\pcs-remote-monitoring-webui\
npm install
npm start
: Launches the project in browser - watches for code changes and refreshes the page.npm run build
: Creates a production ready build.npm test
: Runs test in watch mode, pressq
to quit
Project Structure
The Web UI contains the following sections under src:
assets
: Contains assets used across the application. These include fonts, icons, images, etc.components
: Contains all the application react components. These in include containers and presentational components.services
: Contains the logic for making ajax calls as well as mapping request/response objects to front end models.store
: Contains all logic related to the redux store.styles
: Contains sass used across the application mixins, theming, variables, etc.utilities
: Contains helper scripts used across the application.
Contributing to the solution
Please follow our contribution guildelines and the code style conventions.
Customizing the solution
Please see our developer walkthroughs for more information on customizing and adding to the application.
References
This project was bootstrapped with Create React App.
You can find a guide to using it here.