Skip to content

Commit 5af7749

Browse files
authored
Update README.md
close #15
1 parent 1286d3d commit 5af7749

1 file changed

Lines changed: 33 additions & 8 deletions

File tree

README.md

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,40 @@
11
# WebMapManager
2-
A web version of PyMapManager
2+
A web version of PyMapManager.
33

4-
**Note:** This project is still in development and is not production ready.
4+
**Note:** This project is still in active development and is not production-ready.
55

66
## Setup
77

8-
* `git submodule init`
9-
* `git submodule update`
10-
* Install [NodeJs](https://nodejs.org/en)
11-
* Run `yarn install` to install dependencies
8+
* Initialize submodules:
9+
```bash
10+
git submodule init
11+
git submodule update
12+
```
13+
* Install Node.js(https://nodejs.org/en)
14+
* Install Python 3.11+
15+
* Install JS dependencies:
16+
```bash
17+
yarn install
18+
```
19+
20+
## Build
21+
* Build the static application:
22+
```bash
23+
yarn build
24+
```
25+
* Upload the `/build/` directory to `/WebMapManager/` to your static file server.
26+
* By default, the application is served from a `/WebMapManager/`. To serve the application another directory:
27+
* Update `homepage` in `packages.json`to the directory of your choice:
28+
```json
29+
{
30+
"homepage": "/WebMapManager/",
31+
}
32+
```
1233

1334
## Running WebMapManager
14-
* Run `yarn start` to run the application
15-
* Open [http://localhost:3000](http://localhost:3000) to view it in the browser (Tested on Google Chrome).
35+
36+
* Run the server:
37+
```bash
38+
yarn start
39+
```
40+
* Open [http://localhost:3000](http://localhost:3000) to view it in the browser (Tested on Google Chrome).

0 commit comments

Comments
 (0)