Skip to content
This repository was archived by the owner on Apr 11, 2024. It is now read-only.

Commit f1c9e0e

Browse files
committed
Updating README
1 parent 9bc3b77 commit f1c9e0e

File tree

1 file changed

+4
-85
lines changed

1 file changed

+4
-85
lines changed

README.md

Lines changed: 4 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -21,93 +21,12 @@ This sample application demonstrates the functionality of the Forge Data Visuali
2121

2222
## Setup
2323

24-
### Install nodejs (version 12+)
24+
1. To setup your Forge account, follow this step-by-step tutorial: [GET STARTED WITH FORGE IN 3 STEPS](https://forge.autodesk.com/developer/start-now/signup)
2525

26-
Please download the nodejs package from : https://nodejs.org/en/download/
26+
2. Next, follow the developer's guide - https://forge.autodesk.com/en/docs/dataviz/v1/developers_guide/introduction/
2727

28-
### Git clone
2928

30-
```console
31-
git clone https://github.com/Autodesk-Forge/forge-dataviz-iot-reference-app.git
32-
```
33-
34-
### Run the App with our public model and access token
35-
36-
Yes, you are right. Just one command to get it up and running!
37-
38-
```console
39-
cd forge-dataviz-iot-reference-app
40-
npm install
41-
npm run dev
42-
```
43-
44-
Open your browser:
45-
http://localhost:9000
46-
47-
## For Advanced Users
48-
49-
### Signing up for a Forge account and creating a Forge app
50-
51-
1. Go to https://forge.autodesk.com/
52-
53-
- Sign in if you have an account
54-
- Create an account if you don't have one
55-
2. Select your `avatar` on the top/right corner and choose `My Apps`
56-
![My Avatar/My Apps](./docs/my_app.png)
57-
3. Click `Create App >` button on the top/right.
58-
4. Select `API`
59-
Misc API
60-
5. Add App Information:
61-
App Name
62-
App Description
63-
Callback URL
64-
Your Website URL
65-
6. Click `Create APP` Button
66-
7. Once it's finished, you will get the `Client Id` and `Client Secret`
67-
8. For local development the simplest way is to copy `server/env_template` to `.env` in the same folder.
68-
9. Open `.env` file with text editor or IDE
69-
70-
- Copy and paste the `Client Id` from Step 7 as the value for `FORGE_CLIENT_ID`
71-
72-
- Copy and paste the `Client Secret` from Step 7 as the value for `FORGE_CLIENT_SECRET`
73-
74-
- Add a value for `FORGE_BUCKET`. Remember `FORGE_BUCKET` is unique to all users.
75-
You must give it a unique name. For example - `yourappname.yourwebsite` url
76-
77-
- Save the changes to `.env` file
78-
79-
```console
80-
#Start the app with ENV=local like this
81-
# For Windows
82-
set ENV=local && npm run dev
83-
84-
# For Mac/Unix/Linux
85-
ENV=local npm run dev
86-
```
87-
88-
For a complete step-by-step walk through, follow this tutorial: [GET STARTED WITH FORGE IN 3 STEPS](https://forge.autodesk.com/developer/start-now/signup)
89-
90-
91-
### Setting up a CSV data adapter locally.
92-
Use CSV files as the Time Series datasource by providing the following configuration values in a _.env_ file:
93-
94-
* Change the `ADAPTER_TYPE` to `csv`.
95-
* Set `CSV_MODEL_JSON` to the model file location. For example content format, please refer to: [device-models.json](./server/gateways/synthetic-data/device-models.json)
96-
* Set `CSV_DEVICE_JSON` to the device file location. For example content format, please refer to: [devices.json](./server/gateways/synthetic-data/devices.json)
97-
* Set `CSV_FOLDER` to the CSV folder/directory location. For example content format, please refer to: [Hyperion-1.csv](./server/gateways/csv/Hyperion-1.csv)
98-
* Provide Start and End data for the CSV file using `CSV_DATA_END` and `CSV_DATA_START`. These values will override the timeline. Format: **YYYY-MM-DDTHH:MM:SS.000Z**
99-
* (Optional) Set the `CSV_DELIMITER`. The default is `\t`.
100-
* (Optional) Set the `CSV_LINE_BREAK`. The default is `\n`.
101-
* (Optional) Set the `CSV_TIMESTAMP_COLUMN`. The default is `time`.
102-
* (Optional) Set the `CSV_FILE_EXTENSION`. The default is `.csv`.
103-
104-
### Migrating to the Azure Data Adapter
105-
106-
Please read https://forge.autodesk.com/en/docs/dataviz/v1/developers_guide/advanced_topics/migrate_to_azure/
107-
108-
### Uploading your Revit model
109-
110-
You can also upload your own model using by following these [instructions](https://dev.forge.autodesk.com/en/docs/dataviz/v1/developers_guide/quickstart/replace_model/).
29+
## Advanced Users
11130

11231
### Customization options
11332

@@ -118,7 +37,7 @@ If you'd like to add your own customization on top of our baseline, then you can
11837
- _server/CustomRouter.js_ : Override or add new API routes.
11938

12039
## Further Reading
121-
https://forge.autodesk.com/en/docs/dataviz/v1/developers_guide/introduction/
40+
API Reference - https://forge.autodesk.com/en/docs/dataviz/v1/reference/UI/
12241

12342
## License
12443
This sample app uses an [MIT License](LICENSE)

0 commit comments

Comments
 (0)