Skip to content

Commit

Permalink
doc: add instructions about how to deploy
Browse files Browse the repository at this point in the history
  • Loading branch information
macabeus committed May 11, 2019
1 parent c129c60 commit 4caa128
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Expand Up @@ -48,6 +48,17 @@ Since this is a study project, I'm writing a manual about how I'm developing it,

5 - Then the service will start at the URL `http://localhost:8080/`

## How to deploy

1 - Deploy on GitHub Pages is a very easy task. Just run it:

```
> cd klo-gba.js/brush
> npm run deploy
```

2 - When it finishs, you can see the new website on `http://macalogs.com.br/klo-gba.js/` (or at the respective URL; you can see which is on repository's Settings tab)

## Architecture of this project

klo-gba.js is a monorepo built with two projects: `馃枌 brush` and `鉁傦笍 scissors`. Both projects are written using JS, will be compiled by Babel and uses Webpack.
Expand Down

0 comments on commit 4caa128

Please sign in to comment.