3scale/porta

View on GitHub
README.md

Summary

Maintainability
Test Coverage
[![CircleCI](https://circleci.com/gh/3scale/porta.svg?style=svg)](https://circleci.com/gh/3scale/porta)
[![Maintainability](https://api.codeclimate.com/v1/badges/1fe7e330e8507ea893be/maintainability)](https://codeclimate.com/github/3scale/porta/maintainability)
[![codecov](https://codecov.io/gh/3scale/porta/branch/master/graph/badge.svg)](https://codecov.io/gh/3scale/porta)
[![container-image](https://github.com/3scale/porta/actions/workflows/container-image.yml/badge.svg)](https://quay.io/repository/3scale/porta)

# 3scale "Porta" Component

The 3scale `Porta` component is part of the 3Scale API Management solution and is responsible for serving the:

* Admin Portal for API Providers,
* Account Management and Analytics APIs,
* end-user facing Developer Portal,
* _gateway configuration_, that [Apicast](https://github.com/3scale/apicast) needs during its deployment.

<!-- TODO: potentially add some architecture diagram here -->

## Building from Source

This component is deployed as part of the overall 3scale API Management solution.

Please follow [these instructions](INSTALL.md) on how to set up your development environment and build / deploy this project locally.

## Contributing

Pull requests are (more than) welcome!

For any substantial changes / feature submission, **please open an issue first** to discuss what you would like to change.

For more details on the actual process, please review our detailed [Contribution Guidelines](CONTRIBUTING.md).