Skip to content

README.md: Improved Quickstart Instructions #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dopry wants to merge 1 commit into
base: master
Choose a base branch
from
Open

README.md: Improved Quickstart Instructions #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ and [Node BACstack](https://github.com/fh1ch/node-bacstack).

![](images/overview.gif)

## Usage
## Quickstart

Start Node BACstack Browser by using:

Expand All @@ -22,13 +22,34 @@ git clone https://github.com/fh1ch/node-bacstack-browser.git

cd node-bacstack-browser
npm i

npm run build
npm start
```

> **Note:** If the application window appears as a blank page, force refresh the
> page using F5 (Windows) or CMD+R (OSX).

## Developing

in main.js switch the loadURL

```js
win.loadURL('http://localhost:4200');

// win.loadURL(url.format({
// pathname: path.join(__dirname, 'dist' , 'index.html'),
// protocol: 'file:',
// slashes: true
// }));
```

then start without building

```
npm i
npm start
```

## Contributing

Any help is appreciated, from creating issues, to contributing documentation,
Expand Down