README.md

Open Sesame

A beautiful one-time setup app to autologin into BITS net. Developed on Electron.

For development and running

To clone and run this repository you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:

# Clone this repository
git clone https://github.com/OSDLabs/Open-Sesame.git
# Go into the repository
cd Open-Sesame

# Install dependencies and run the app
npm install && npm start

Before sending in a pull request, you need to run jshint to keep consistent code quality

# Run the lint script 
npm run lint

To test packaged releases in development mode:

# Install electron-packager
npm install -g electron-packager
# For macOS
electron-packager . --platform=darwin
# For Linux
electron-packager . --platform=linux

Learn more about Electron and its API in the documentation.