0.5.0 • Published 4 years ago

test-ahau-server v0.5.0

Weekly downloads
-
License
AGPL-3.0
Repository
gitlab
Last release
4 years ago

Āhau

A whakapapa app that works peer-to-peer, and doesn't require internet. All data is held by you and those friends you connect with, and is cryptographically secured.

Built on scuttlebutt

For more info see ahau.io

Setup

$ npm install

Development

$ npm run serve
// start a webpack dev-server which serves up live-updating UI

Then in another terminal

$ npm run start:dev
// launches the scuttlebutt + graphql servers + electron
// which then asks for UI from dev-server

OTHER TOOLS

  • Graphiql
    • a sweet GraphQL tool for exploring generated doc and practicing queries/ mutations with the server
    • start the above dev environment then go to http://localhost:4000/graphql
  • Storybook
    • a tool to help you build components in isolation
    • start it with npm run storybook
    • serves up *.stories.js files

NOTES

  • live-reload doesn't work for ssb-server (back end) code.
  • Windows sets env differently. Open 2 Powershell windows and run the following in each:
    • npm run serve
    • $env:NODE_ENV="development", then npm start (set the env to development, then launch electron app)

Production Build

$ npm run build

Compiles and minifies code (and assets) for production, outputs to ./build. You can try running the build with npm run start.

Publishing installers

$ npm run publish

Builds installer (using compiled clientside code + back end code), and outputs to ./dist/installers.

NOTES

  • Mac needs

    • Application Installer + Apllication certificates set up in your apple keychain for signing
    • an electron-builder.env with environment variables APPLE_ID, APPLE_ID_PASS for notarization, e.g :
      APPLE_ID=name@company.com
      APPLE_ID_PASS=asdl-tyan-osla-ttyb
      • APPLE_ID_PASS is an application specific password created from your APPLE_ID
  • Windows needs

Customize configuration

See Configuration Reference.

see also:

npm run test
npm run lint