README.md

pontifex-api

An Azure Function backend for Pontifex.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Maintainers

About The Project

The Pontifex API layer abstracts away the interactions with Azure AD and supports actions within the pontifex-ui.

(back to top)

Built With

• Azure Function

(back to top)

Getting Started

Prerequisites

1. Install the Azure Functions Core Tools
2. Install the Azure CLI
3. Install Node 16. I recommend using nvm

Installation

1. Clone the repo

   git clone https://github.com/Optum/pontifex-api.git

2. Install NPM packages

   npm install

3. Create an Azure AD App Registration with the following Application Permissions:
   1. AccessReview.ReadWrite.All
   2. AppCatalog.Read.All
   3. Application.ReadWrite.OwnedBy
   4. AppRoleAssignment.ReadWrite.All
4. Create a CosmosDB Gremlin Instance
5. Update the local.settings.example.json with the values from the previous 2 resources and rename it to be local. settings.json
6. run npm start

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the Apache 2.0 License. See LICENSE.txt for more information.

(back to top)

Maintainers

• Alexander Aavang
  • GitHub Enterprise: aaavang
  • Email: alexander.aavang@optum.com, alex.aavang@gmail.com

(back to top)