/beaker

An Experimental P2P Browser
  1. JavaScript 86.5%
  2. CSS 13.0%
  3. Other 0.5%
JavaScript CSS Other
Find file
Latest commit 0cb9392 Oct 29, 2016 @pfrazee pfrazee committed on GitHub Merge pull request #161 from beakerbrowser/apps 
Dat Archives DB refactor
Permalink
Failed to load latest commit information.
app improve read-only archive header rendering, when unsaved Oct 29, 2016
build new icon Aug 23, 2016
tasks add ELECTRON_PATH env var Oct 20, 2016
tests add dat web-api tests Oct 25, 2016
.editorconfig reorg for clarity and convert to 2-space tabs May 26, 2016
.gitignore WIP - rearch dat backend to support apps and garbage collection (clai… Oct 26, 2016
ISSUE_TEMPLATE add an issue template Sep 3, 2016
README.md move contents of beaker-plugin-dat into this repo Oct 25, 2016
build-notes.md add test skeleton Oct 25, 2016
gulpfile.js rewrite build process to use electron-builder Aug 20, 2016
package.json switch to custom electron build; set webpreferences to enable display… Oct 18, 2016
screenshot.png readd screenshot Aug 11, 2016
settings.json WIP - rearch dat backend to support apps and garbage collection (clai… Oct 26, 2016

README.md

beaker browser

logo.png

Beaker is an experimental Browser. It adds new technologies for Peer-to-Peer applications while staying compatible with the rest of the Web. Visit the website.

Please feel free to open usability issues. Join us at #beakerbrowser on Freenode.

Binaries

OSX 64-bit

Documentation

Env Vars

  • beaker_log_level: how much logging to put out. Must be: 'trace', 'debug', 'info', 'warn', or 'error. Default: 'warn'.

Running the tests

Tests use their own package.json:

cd tests
npm install

To run:

cd tests
npm test

Building from source

Requires node 6.2.1. In linux (possibly also OSX) you need libtool, m4, and automake.

sudo apt-get install libtool m4 automake

To build:

git clone https://github.com/pfrazee/beaker.git
cd beaker
npm install
npm run rebuild #see https://github.com/electron/electron/issues/5851
npm start

If you pull latest from the repo and get weird module errors, do:

npm run burnthemall

This invokes the mad king, who will torch your npm_modules, and do the full install/rebuild process for you. npm start should work afterwards.

If you're doing development, npm run watch to have assets build automatically.

License

Modified MIT License (MIT)

Copyright (c) 2016 Paul Frazee

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

  1. Any project using the Software will include a link to the Beaker project page, along with a statement of credit. (eg "Forked from Beaker")

  2. The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.