Skip to content

Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.

Website publishing cmd

Balthazar Gronon9330a1ef5283
diff --git a/.gitignore b/.gitignore
index 9f9bdf88e..c275bed2f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -9,4 +9,8 @@ yarn-error.log
package-lock.json
.DS_Store
-.idea
\ No newline at end of file
+.idea
+
+/bundle*.js
+/favicon.png
+/index.html
diff --git a/README.md b/README.md
index 75ed20dae..9bc3c5cea 100644
--- a/README.md
+++ b/README.md
@@ -1,32 +1,25 @@
# kepler.gl
-##Links
-
-### Node
-Use Node v6
-
-### Local dev
-```
-npm install
-```
-or
-```
-yarn --ignore-engines
-```
-then
-```
-npm start
-```
-
-### Develope kepler.gl website
-
-To start website
-```
-npm run start:website
-```
-
-To build website
-```
-cd website
-npm run build
-```
\ No newline at end of file
+### Development
+
+Install node (`> 6`), yarn, and project dependencies
+
+ yarn --ignore-engines
+
+Run the project
+
+ npm start
+
+### Website
+
+In order to start
+
+ yarn web
+
+To checkout the build
+
+ cd website && yarn build
+
+Publish on github pages
+
+ yarn deploy
diff --git a/package.json b/package.json
index a5b03f5d9..84630627e 100644
--- a/package.json
+++ b/package.json
@@ -14,7 +14,8 @@
"build-static": "cp -r ./src/static/* dist && cp index.html dist",
"build-script": "webpack -p --env.prod",
"build": "npm run build-clean && npm run build-static && npm run build-script",
- "start:website": "(cd website && (path-exists node_modules || npm i) && npm run start)"
+ "web": "(cd website && (path-exists node_modules || npm i) && npm run start)",
+ "deploy": "(cd website && yarn build && cp dist/* .. && git checkout gh-pages && cd .. && git add . && git commit -m 'Update website' && git push origin gh-pages && git checkout master)"
},
"dependencies": {
"classnames": "^2.2.5",