Skip to content

Commit f2c8f03

Browse files
authored
Update README.md
1 parent 38ce4e6 commit f2c8f03

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

README.md

+56
Original file line numberDiff line numberDiff line change
@@ -82,3 +82,59 @@ Install npm (version > 8.5.4) - https://www.npmjs.com/ (npm install -g npm)
8282
</p>
8383
</li>
8484
</ol>
85+
<p>
86+
## Directories
87+
- \api - This contains a .NET web API back end for profile designer. Within this solution, the OPC translations will occur, database connections will occur, etc.
88+
- \frontend - This contains the REACT front end for profile designer.
89+
- \SampleNodeSets - This contains nodesets that we use to import into system. Any OPC UA compliant nodeset is permitted. These are stored just for convenience while developing within the system.
90+
- \sql - This contains the SQL script used to generate the DB structure and insert required lookup data as well as some sample users.
91+
92+
## How to Build
93+
- Clone the repo from GIT.
94+
95+
If you have an older clone that is missing the common submodule:
96+
```ps
97+
cd c:\sources\cesmii\profiledesigner
98+
git submodule add https://github.com/cesmii/cesmii-common
99+
```
100+
101+
- **Build/Run the front end:**
102+
```powershell
103+
cd \frontend
104+
npm install
105+
npm run start
106+
```
107+
- Verify the site is running in a browser: http://localhost:3000
108+
109+
> **Note**
110+
>
111+
> The ENV files in the root React folder point to the base URL for the web API.
112+
> Login: The login process was intentionally simple. Use cesmii/cesmii to login.
113+
114+
115+
- **Build/Run the back end API (.NET 6 Solution):**
116+
- Standard .NET build and run.
117+
118+
- **PostgreSql DB**
119+
See above for initial install instructions.
120+
- Run pgAdmin
121+
- Create local DB (see AppSettings.json for database name.)
122+
- Open the Query Tool (Tools menu)
123+
- Open the CESMII-Profile-Designer\sql\CESMII.ProfileDesigner.DB.sql file
124+
- Create the cesmii role/login and the database (comment out everything except the create role and create database sections and run the script)
125+
- Open a query tool on the newly created database and run the rest of the script
126+
- Change the password on the cesmii login to match the one in the appsettings.development.json file.
127+
128+
## Run Profile Designer, Market Place and Cloud Library locally
129+
130+
### Profile Designer: Front End port 3002, API port 5004
131+
132+
1. Add a frontend/.env.development file with the following entries/content:
133+
```
134+
REACT_APP_BASE_API_URL=https://localhost:5004/api
135+
PORT=3002
136+
```
137+
138+
2. Change
139+
140+
</p>

0 commit comments

Comments
 (0)