Giter Club home page Giter Club logo

developer-hub's Introduction

Awell Developers

Repository for Awell Health's developer portal. The portal houses the documentation and API reference for our Orchestration API.

NPM Next JS TailwindCSS Commitizen friendly

Getting Started

Installation

First, install all packages via npm.

npm i

You can then run the development server:

npm run dev

Open http://localhost:3000 with your browser to see the result.

Editing files

Most of the content is managed through mdx files and these can be found in /content/**/*. Editing the markdown file will automatically update the content.

Pages that are not managed through mdx files can be edit in the /pages directory.

Adding a new page

  1. Create a .mdx file in the appropriate location (eg /content/awell-orchestration/docs/getting-started/new-doc.mdx)
  2. Add your new page to the menu, this is not done automatically! See /src/config/menus/*.ts and add your new page to the appropriate file: docsMenu if it's a documentation page and apiMenu if it's a page that belongs to the API reference.
  3. That's it!

Credits

Website built with NextJS and Tailwind. We ❤️ the Tailwind docs so we've used their layout and some of the components from their website. We've also used some components from Flowbite.

developer-hub's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

developer-hub's Issues

[EXT-61] Configure basic auth for incoming webhooks

We listen to webhooks here: https://github.com/awell-health/awell-extension-server/blob/72ed8e091355863dad05227d15cc3fbe9cf6af6a/src/WebServer.ts

What we'd like to be able to do:

  • User can configure username + password in extension settings (and share these values with webhook sender)
  • When a webhook is received
    • If the above values are configured, then we
      • return a 401 and send a challenge using WWW-Authenticate header
      • webhook producer will respond with Authorization: Basic {base64(username:password) headers
      • we verify the credentials and continue, otherwise reject as unauthorized
    • If the values are not configured, then we continue without challenging
  • Use @fastify/basic-auth plugin for this so we don't need to roll our own challenge mechanism

From SyncLinear.com | EXT-61

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.