Skip to content

Commit c3fd9c3

Browse files
author
doublebyte1
committed
- updated README
1 parent d87774d commit c3fd9c3

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,31 @@ This repository hosts the source of the OGC Developer Website https://developer.
55

66
Currently, the website is served from the [gh-pages](https://github.com/opengeospatial/developer-website/tree/gh-pages) branch. Read [this note](#note-about-publishing-the-website), to understand how the website is generated.
77

8-
## Version 3.0
9-
This is now the main version.
8+
## Quick Start :rocket:
109

11-
Install:
10+
Clone this repository with:
11+
12+
`git clone https://github.com/opengeospatial/developer-website.git`
13+
14+
Then enter the folder:
15+
16+
`cd developer-website`
17+
18+
Install dependencies:
1219

1320
`npm install`
1421

15-
Run locally (includes development server):
22+
Start development server:
1623

1724
`npm start`
1825

26+
Once you start the development server, the site will be available at:
27+
28+
`http://localhost:3000`
29+
30+
The hot reload will ensure that the changes you do on the code will be reflected on the browser.
31+
32+
1933
### Note about Publishing the Website
2034

2135
Commit all your changes to the `master` branch. **The `gh-pages` branch will be wiped each time, and generated dynamically from [GitHub actions](https://github.com/opengeospatial/developer-website/actions/)**. Apart from copying the static build, the action will copy the `api` folder and pull remote repos that live under `developer.ogc.org`. If you need to add anything else, just edit the [workflow file](https://github.com/opengeospatial/developer-website/blob/master/.github/workflows/main.yml) directly.

0 commit comments

Comments
 (0)