diegopoza Merge pull request #362 from jsonwebtoken/disclaimer-warning
Add disclaimer warning above the debugger
Latest commit 018ec65 Nov 14, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
css Fix HTTP use inside HTTPS. Mar 2, 2018
fonts zeroclip plugin deleted Jul 1, 2015
html/extension Extension and website working together. Jan 15, 2018
img Manual merge of PR #193 + fixed logo. Mar 23, 2018
src Fix metrics key selection. Sep 28, 2018
stylus Add disclaimer warning above the debugger Nov 10, 2018
test Increse functional test timeouts (CI failing). Sep 28, 2018
views Merge pull request #362 from jsonwebtoken/disclaimer-warning Nov 13, 2018
.deployment-trigger Deployment test Oct 1, 2018
.gitignore Do not put IDE files in .gitignore, handle them locally. Apr 20, 2018
.travis.yml Deployment test: disable Travis cache. Jun 8, 2018
CNAME Create CNAME Mar 10, 2014
Gruntfile.js Separate languages into their own data files. Mar 28, 2018
LICENSE.txt Update licence. Jun 8, 2018
README.md Add link to Gruntfile Apr 26, 2018
app.json app json Apr 3, 2016
manifest.json Set version 3.0.0 (website and extension). Jun 7, 2018
opensearch.xml Adding opensearch.xml file. Sep 29, 2014
package-lock.json Metrics appear to be working locally. Sep 28, 2018
package.json Use LTS version of node Oct 1, 2018
server.js Heroku deployment requirements. Mar 2, 2018
webpack.common.js Improve bundle size. Jun 7, 2018
webpack.extension-dev.js Update to Webpack 4. Mar 5, 2018
webpack.extension-prod.js Update to Webpack 4. Mar 5, 2018
webpack.website-dev.js Fix metrics key selection. Sep 28, 2018
webpack.website-prod.js Metrics appear to be working locally. Sep 28, 2018
webpack.website-unit-tests.js Improved selection of browsers to support. Jun 6, 2018

README.md

JWT.io

Build Status

How to add a library

To add a library, simply edit the right JSON file located at views/website/libraries. Each language gets its own file. Multiple libraries share the same language file.

To add a new language, simply add a JSON file in the same folder as the others. It will get automatically recognized. If you add a new language, you will need to provide a proper icon for it and place it in the img folder.

Here's a commented example of the .NET language file (0-.NET.json). All fields must have valid values unless noted:

{
  // Language name (unique)
  "name": ".NET",

  // Unique identifier that will be used as a CSS class
  // for this language (only valid CSS class names).
  "uniqueClass": "net",
  
  // The language icon, SVG format preferred, should be placed
  // in /img directory.
  "image": "/img/1.svg",
  
  // The color of header that displays the name of the language
  // and the icon. This is a valid CSS color definition.
  "bgColor": "rgb(42, 168, 229)",
  
  // An array of libraries for this language.
  "libs": [
    {
      // In case the library suffered from a vulnerability, the
      // minimum version in which the vuln was fixed must be
      // listed here. Optional (can be null).
      "minimumVersion": "1.0.1", // or null
      
      // Supported features, true for supported,
      // false for not supported.
      "support": {
        "sign": true,
        "verify": true,
        "iss": true,
        "sub": true,
        "aud": true,
        "exp": true,
        "nbf": true,
        "iat": true,
        "jti": true,
        "hs256": true,
        "hs384": true,
        "hs512": true,
        "rs256": true,
        "rs384": true,
        "rs512": true,
        "es256": true,
        "es384": true,
        "es512": true
      },
      
      // Author URL, can be GitHub profile, personal page
      // company page, etc. Can be null.
      "authorUrl": "https://www.microsoft.com", // or null
      
      // Author name.
      "authorName": "Microsoft",
      
      // For the star count, this is the GitHub repository path,
      // (usually user/repo). Can be null (no star count shown).
      "gitHubRepoPath": "AzureAD/azure-activedirectory-identitymodel-extensions-for-dotnet", // or null
      
      // URL for source code.
      "repoUrl": "https://github.com/MSOpenTech/azure-activedirectory-identitymodel-extensions-for-dotnet",
      
      // Install command, can be HTML or plain text.
      "installCommandHtml": "Install-Package<br><a href=\"https://www.nuget.org/packages/System.IdentityModel.Tokens.Jwt/\">System.IdentityModel.Tokens.Jwt</a>"
    }
  ]
}

How to build

First, install the required dependencies:

npm install

In order to build (and run) the project execute:

./node_modules/.bin/grunt

You will find the generated files in the dist directory. For the website, you can run a server at its root. For example: http-server dist/website. The default grunt task runs a server at https://127.0.0.1:8000 and watches for changes.

To run tests, execute:

./node_modules/.bin/grunt test

Look at the end of the Gruntfile for other common tasks.

Happy hacking!