Skip to content

A browser extension to improve the Sigarra user experience

License

Notifications You must be signed in to change notification settings

NIAEFEUP/nitsig

Repository files navigation

Developing

First, you must have yarn installed.

Install dependencies:

yarn install

Build for the first time:

yarn build

Choose your favorite browser and start developing:

yarn run dev:firefox

or

yarn run dev:chrome

This command will initialize a browser window and load the extension, watching for changes and reloading the window automatically.

Building a bundle

yarn build

Linting and formatting

In order to maintain our codebase we are using Prettier for formatting and ESLint for linting.

If you only want to check for formatting issues run:

yarn format

Or if you want to have Prettier fix them:

yarn format:fix

Similarly, to check for linting issues run:

yarn lint

And, if you wish to fix the warnings that ESLint picks up, run:

yarn lint:fix

Loading a bundle

Chrome or Edge Firefox Safari
  1. Open chrome://extensions or edge://extensions
  2. Turn on the Developer mode toggle
  3. Click on the Load unpacked button
  4. Select the folder bundle/chrome
  1. Open about:debugging#/runtime/this-firefox
  2. Click on the Load Temporary Add-on... button
  3. Select the file bundle/firefox/manifest.json
  1. Open bundle/safari/NitSig for NitSig.xcodeproj
  2. Click the Play button in Xcode ("start the active scheme")
  3. Configure Safari in macOS to run unsigned extensions

Components Page

Checkout the components page by adding /components to the end of any Sigarra URL.