HashNotes

Project description - one or two paragraphs. The enemy is dark and creates major problems. The solution is now available and the World can rejoice.

• Getting Started
• How it Works
• Start development build with Electron
• Testing
• Contributing
• Modus Create
• Licensing

Getting Started

1. git clone https://github.com/ModusCreateOrg/hashnotes

2. cd hashnotes

3. npm i

4. npm start

How it works

{Describe how it works. Include images if possible.}

Start development build with Electron

1. Add Electron to Capacitor

   • Note: You only need to do this step once

   ./node_modules/.bin/cap add electron

2. npm run build

3. npm run cap-open-electron

Testing

• Lint

  npm run lint

• Unit

  npm test

• Unit (via CI)

  npm run test.ci

• E2E

  npm run e2e

• Gimbal

  npm run build && npm run gimbal

Distribute Electron Build

1. Add Electron to Capacitor

   • Note: You only need to do this step once

   ./node_modules/.bin/cap add electron

2. npm run build

3. npm run electron-pack

4. Refer to Electron dist directory for the files: ./electron/dist/

Contributing

See Contributing Guide

E2E testing is brought to you by BrowserStack.

Modus Create

Modus Create is a digital product consultancy. We use a distributed team of the best talent in the world to offer a full suite of digital product design-build services; ranging from consumer facing apps, to digital migration, to agile development training, and business transformation.

This project is part of Modus Labs.

Licensing

This project is MIT licensed.