examples showcasing various features of the SAFE Network
Branch: master
Clone or download
S-Coyle Merge pull request #414 from S-Coyle/email_app_deprecated
docs/README: updated email app readme to inform of its deprecation
Latest commit 787bb13 Feb 12, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
editable-comments-web rename the var names Dec 7, 2017
email_app docs/README: updated email app readme to inform of its deprecation Feb 12, 2019
example_common_js_app_utils MAID-2373 Refactored web hosting manager (#317) Nov 3, 2017
non-editable-comments-web rename the var names Dec 7, 2017
safe_app_electron_quick_start fix: add String "keys" to Safe Web App and Safe Electron examples for… Feb 1, 2019
safe_web_api_playground chore/playground: adds snippets to highlight XOR-URL, RDF, and WebID … Dec 12, 2018
safe_web_app_quick_start fix: add String "keys" to Safe Web App and Safe Electron examples for… Feb 1, 2019
safe_webrtc_example
.gitignore chore/CI configuration Dec 5, 2017
.travis.yml chore/config: update Node JS version requirement to ^8.0.0 Jan 18, 2018
LICENSE-BSD.md docs/license: add MIT and BSD licenses (#383) May 10, 2018
LICENSE-MIT.md docs/license: add MIT and BSD licenses (#383) May 10, 2018
README.md fix/readme: fix broken link of WHM Jan 24, 2019
appveyor.yml chore/config: update Node JS version requirement to ^8.0.0 Jan 18, 2018
package.json
post-packaging.js fix/use promise to await for archiver to finalize before applying sha… Dec 21, 2017
yarn.lock feat/build: scripts for post packaging Sep 29, 2017

README.md

Build status

safe_examples

Examples showcasing various features of the SAFE Network.

email_app (NodeJS - Electron)

email_app, written in NodeJS, is an application to exchange messages.

safe_web_api_playground (NodeJS - Electron)

safe_web_api_playground, written in NodeJS, is an application allowing you to explore the web API.

web_hosting_manager (NodeJS - Electron)

web_hosting_manager, written in NodeJS, is an application which allows hosting and managing web files.

safe_app_electron_quick_start (NodeJs - Electron)

safe_app_electron_quick_start, it's a boilerplate with a tutorial to create an Electron application.

safe_web_app_quick_start (NodeJs - SAFE Web API)

safe_web_app_quick_start, it's a boilerplate with a tutorial to create a SAFE Web application which uses the Web API to interact with the SAFE Authenticator, and to connect with the SAFE Network.

Note: For more details and build-instructions, please check the corresponding folder's README.

Packaging

To run a complete package of the email/webhosting apps, (assuming each project has their own dependencies installed) you can:

  • Run yarn in the root examples directory
  • Run yarn install-all to install and build email_app and web_hosting_manager.
  • Use either of the commands below to separately package each app:
  • Run yarn pack:webhosting to package and zip the app with all required files (to: web_hosting_manager/release).
  • Run yarn pack:email to package and zip the app with all required files (to: email_app/out).
  • Alternatively, run yarn package-all to package both email_app and web_hosting_manager

License

The projects published in this repository are dual-licensed under

at your option.