https://github.com/awell-health/developer-hub

Awell's Developer Hub website.
https://github.com/awell-health/developer-hub

graphql healthcare orchestration pathways workflows

Last synced: 3 months ago
JSON representation

Awell's Developer Hub website.

• Host: GitHub
• URL: https://github.com/awell-health/developer-hub
• Owner: awell-health
• Created: 2022-02-23T11:04:11.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-31T13:38:49.000Z (4 months ago)
• Last Synced: 2024-10-31T14:36:11.549Z (4 months ago)
• Topics: graphql, healthcare, orchestration, pathways, workflows
• Language: TypeScript
• Homepage: https://developers.awellhealth.com/
• Size: 9.98 MB
• Stars: 10
• Watchers: 4
• Forks: 9
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Awell Developers

Repository for [Awell Health's developer portal](https://developers.awellhealth.com). The portal houses the documentation and API reference for our Orchestration API.

![NPM](https://img.shields.io/badge/NPM-%23000000.svg?style=for-the-badge&logo=npm&logoColor=white) ![Next JS](https://img.shields.io/badge/Next-black?style=for-the-badge&logo=next.js&logoColor=white) ![TailwindCSS](https://img.shields.io/badge/tailwindcss-%2338B2AC.svg?style=for-the-badge&logo=tailwind-css&logoColor=white) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

## Getting Started

### Installation

First, install all packages via npm.

```bash

npm i

```

You can then run the development server:

```bash

npm run dev

```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

### Editing files

Most of the content is managed through [mdx files](https://mdxjs.com/) 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](https://tailwindcss.com/) so we've used their layout and some of the components from their website. We've also used some components from [Flowbite](https://flowbite.com/).